Skip to content

Analytics adapters: document thin pages, mark removed modules - #6863

Open
patmmccann wants to merge 1 commit into
prebid:masterfrom
patmmccann:agent-analytics-docs-4093
Open

patmmccann wants to merge 1 commit into
prebid:masterfrom
patmmccann:agent-analytics-docs-4093

Conversation

@patmmccann

Copy link
Copy Markdown
Collaborator

Closes #4093.

The empty "Please visit " links from the original report were already fixed. This covers what was left from the later comments: the analytics adapters with only a one-line "visit our website" page, plus pages for modules that are no longer in Prebid.js.

  • Documented from the adapter source (Prebid.js master): adkernelAdn, adxpremium, appier, asteriobid, AsteriobidPbm, datablocks, finteza, invisibly, livewrapped, medianet, oolo, optimon, pubperf, pubstack, pubwise and pubxai. Each page now has:

    • a pbjs.enableAnalytics example with the real provider code (appierAnalytics, medianetAnalytics, invisiblyAnalytics and prebidmanager for AsteriobidPbm differ from the module name),
    • an options table with types, required/optional and defaults as the code enforces them,
    • what the adapter collects and where it sends it (events, endpoints, transport, storage).

    datablocks, optimon, pubperf and pubstack forward events to the vendor's own script and make no requests themselves; their pages say so.

  • Removed modules: konduit (removed in 10.0) and realvu (removed in 8.0) now have pbjs_version_notes and enable_download: false.

  • assertiveYield: not removed. The adapter isn't in the Prebid.js repository; Assertive Yield distributes it privately to its customers. The page now says so.

  • Lint: headings shifted so each page starts at h2 (MD001) and tables use compact style (MD060). Checked with markdownlint-cli2 0.20.0 (matching CI) and 0.22.1.

Where an adapter's readme in the Prebid.js repo disagreed with its code, the pages follow the code:

  • adxpremium: the readme example uses pubID, but the code reads pubId.
  • datablocks: the readme lists publisherId, sourceId and host, which the code never reads.
  • pubxai: the readme's hostName example includes https://, but the code adds the scheme itself.
  • appier: the readme says the Currency module is required; it's only needed for non-USD bids.
  • adkernelAdn, asteriobid, finteza, livewrapped: options missing from the readmes (queueTimeout, sampling/pageViewId/url, host, endpoint/ext) are documented.

🤖 Generated with Claude Code

…ules (prebid#4093)

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@netlify

netlify Bot commented Oct 24, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for prebid-docs-preview ready!

Name Link
🔨 Latest commit 6d33e64
🔍 Latest deploy log https://app.netlify.com/projects/prebid-docs-preview/deploys/6add1b3229c2fc8fb03c2b44
😎 Deploy Preview https://deploy-preview-6863--prebid-docs-preview.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 24, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-10-24T21:00:33.753732Z 6d33e64 PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 6d33e6461c

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

description: Konduit Analytics Adapter
modulecode: konduit
enable_download: false
pbjs_version_notes: removed in 10.0

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Render removal notes on analytics pages

When a reader follows Konduit (and likewise RealVu) from the unfiltered full list in overview/analytics.md:103-109, this new value is never rendered: _layouts/analytics.html:35-39 outputs only the title/content, while download.md:89 drops disabled analytics before showing anything. As a result, the adapter page still looks current and never communicates its 10.0 removal; render the front-matter note in the analytics layout or list.

AGENTS.md reference: AGENTS.md:L13-L13

Useful? React with 👍 / 👎.


The adapter listens to `auctionInit`, `bidRequested`, `bidResponse`, `bidderDone`, `bidTimeout`, `auctionEnd`, `bidWon`, and `adRenderFailed`. It records requests, responses (highest bid per bid request), timeouts, wins, and render failures, including CPM, size, media type, floors, deal ID, bid `meta`, and the GDPR applies flag and consent string. If the ad unit's element has a `data-adunitid` attribute, its value is included.

Data is sent as a JSON `POST` (ajax) to `lwadm.com` 500 ms after `auctionEnd`. Wins and render failures that occur after that are sent in a separate request as they happen.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Describe posts to the configured Livewrapped endpoint

When a publisher sets options.endpoint, the table at livewrapped.md:29 says it overrides the collection URL, but this sentence still says the POST goes to lwadm.com; this gives custom-endpoint users the wrong destination for CSP allowlists or troubleshooting. Refer to the configured endpoint here and identify lwadm.com only as the default.

AGENTS.md reference: AGENTS.md:L15-L15

Useful? React with 👍 / 👎.

Comment on lines +41 to +42
- `https://api.pbxai.com/analytics/auction`
- `https://api.pbxai.com/analytics/bidwon`

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Reflect hostName in the listed Pubx.ai URLs

When a publisher supplies a nondefault options.hostName, pubxai.md:30 says it selects the collection hostname, but these bullets still state that beacons go to api.pbxai.com; custom-host users will therefore inspect or allowlist the wrong destination. Show https://<hostName>/... here or explicitly label the current URLs as defaults.

AGENTS.md reference: AGENTS.md:L15-L15

Useful? React with 👍 / 👎.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Several analytics adapters have broken / empty documentation

1 participant