Skip to content

Add category to Ads Events and expandable response examples#23

Open
talas-discord[bot] wants to merge 1 commit into
mainfrom
docs/add-category-and-response-examples
Open

Add category to Ads Events and expandable response examples#23
talas-discord[bot] wants to merge 1 commit into
mainfrom
docs/add-category-and-response-examples

Conversation

@talas-discord

@talas-discord talas-discord Bot commented Mar 10, 2026

Copy link
Copy Markdown
Contributor

Changes

This PR makes two improvements to the data schema documentation:

1. Added missing category field to Ads Events table

The category field was documented in Search, Browsing, YouTube, and Receipts events but was missing from Ads Events. According to the live Query API OpenAPI spec, Ads events include a category field in responses (confirmed at line 3285 in the OpenAPI schema).

Added row:

| `category` | The topic category this ad relates to | "/Shopping/Apparel/Footwear" |

2. Added expandable response examples for all event types

Each event type now includes a collapsible response example that users can expand to see a complete API response. This keeps the page clean and scannable by default while providing detailed examples when needed.

Implementation:

  • Used Mintlify <Accordion> component for each event type
  • Examples show the full sync response envelope with realistic data
  • Matches the live API response format from the OpenAPI specification

Event types updated:

  • ✅ Search Events
  • ✅ Browsing Events
  • ✅ YouTube Events
  • ✅ Ads Events (+ added missing category field)
  • ✅ Receipts Events

Verification

All response examples verified against the live Query API OpenAPI schema fetched from https://query.emergedata.ai/openapi.json

@github-actions

Copy link
Copy Markdown

Preview Deployment

Your docs preview is ready:

https://pr-23.docs-preview.emergedata.ai

Updated for commit e7b52a3

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.

0 participants