feat: add render event to /v2/events - #203
Open
tomaslara-topsort wants to merge 3 commits into
Open
Conversation
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
- 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.
celzo
approved these changes
Jul 28, 2026
jilanglois
approved these changes
Jul 29, 2026
Phfollert
approved these changes
Aug 4, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Documents the new
renderedevent 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 arendersarray (maxItems: 50).Renderschema:resolvedBidId/occurredAt/opaqueUserId/idrequired;placement/page/deviceType/channeloptional. Sponsored-only, non-chargeable and non-attributable.Note: unrelated strict-lint fix
This PR also removes a redundant
minimum: 0from thequalityScoresitems schema (used in/v2/auctions), keepingexclusiveMinimum: 0, which matches its own description ("values must be greater than 0"). This is not related to the render event: it is a pre-existingno-mixed-number-range-constraintsviolation onmainthat therecommended-strictRedocly check flags across the whole spec, so it blocks any PR touching this file. Fixed here only to unblock.Validation
renders(binding:"max=50"),Renderfields/required flags perbehavior-data-service/bdssrv/v2/model_render.go, andchannel/deviceTypeenums perts.Channel/ts.DeviceType.redocly lintpasses (only the pre-existing, unrelated warning);yamllintclean.