Skip to content

feat: add render event to /v2/events - #203

Merged
tomaslara-topsort merged 3 commits into
mainfrom
tlaraa/feat/render_event_docs
Aug 7, 2026
Merged

feat: add render event to /v2/events#203
tomaslara-topsort merged 3 commits into
mainfrom
tlaraa/feat/render_event_docs

Conversation

@tomaslara-topsort

@tomaslara-topsorttomaslara-topsort commented Jul 28, 2026

Copy link
Copy Markdown
Contributor

Summary

Documents the new rendered event in the public Events API (/v2/events), so clients can report renders alongside impressions, clicks and purchases. A render is an ad placed in the DOM (IAB "rendered").

Changes (topsort-api-v2.yml)

  • /v2/events: add a Renders bullet and update the request-body description.
  • EventsRequest: add a renders array (maxItems: 50).
  • New Render schema: resolvedBidId / occurredAt / opaqueUserId / id required; placement / page / deviceType / channel optional. Sponsored-only, non-chargeable and non-attributable.
  • Add a render request example; order render before impression (funnel: rendered → viewable).

Note: unrelated strict-lint fix

This PR also removes a redundant minimum: 0 from the qualityScores items schema (used in /v2/auctions), keeping exclusiveMinimum: 0, which matches its own description ("values must be greater than 0"). This is not related to the render event: it is a pre-existing no-mixed-number-range-constraints violation on main that the recommended-strict Redocly check flags across the whole spec, so it blocks any PR touching this file. Fixed here only to unblock.

Validation

  • Matches the auction-engine v2 contract — request field renders (binding:"max=50"), Render fields/required flags per behavior-data-service/bdssrv/v2/model_render.go, and channel / deviceType enums per ts.Channel / ts.DeviceType.
  • redocly lint passes (only the pre-existing, unrelated warning); yamllint clean.

Document the `rendered` event (IAB "render" — an ad placed in the DOM), reported via /v2/events alongside impressions, clicks and purchases:
- add a `renders` array to EventsRequest (max 50) and a new `Render` schema
- order render before impression to follow the funnel; add a request example
@tomaslara-topsort
tomaslara-topsort requested a review from a team as a code ownerJuly 28, 2026 22:35
- format the render additions with prettier
- drop redundant `minimum: 0` from the qualityScores items schema (exclusiveMinimum: 0 already implies > 0). Unrelated to the render event — a pre-existing recommended-strict violation (no-mixed-number-range-constraints) that blocks the whole-file strict lint, fixed here to unblock this PR.
@tomaslara-topsort
tomaslara-topsort merged commit cb03536 into mainAug 7, 2026
7 checks passed
@tomaslara-topsort
tomaslara-topsort deleted the tlaraa/feat/render_event_docs branch August 7, 2026 14:11
Sign up for freeto 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.

4 participants

@tomaslara-topsort@celzo@Phfollert@jilanglois