Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: refactor events description #139

Merged
merged 5 commits into from
Jan 10, 2025
Merged
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 11 additions & 8 deletions topsort-api-v2.yml
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,9 @@ paths:
tags:
- Auctions
summary: Create auctions
description: |
Use the `/auctions` endpoint to create and run auctions. Each batch of auction requests can be a mix of
sponsored listing auctions and banner auctions. Each auction type has a unique body schemas.
operationId: createAuctions
requestBody:
description: |
Expand Down Expand Up @@ -297,16 +300,16 @@ paths:
tags:
- Events
summary: Report events
description: |
Use the `/events` endpoint to notify Topsort about significant user interactions on the marketplace app:
- **Impressions** — a user viewed an asset.
- **Clicks** — a user clicked on an asset.
- **Purchases** — a user created an order.

Interactions require either a `resolvedBidId` from the `/v2/auctions` response or an `entity` that describes
the asset.
operationId: reportEvents
requestBody:
description: |
Use the `/events` endpoint to notify Topsort about significant consumer interactions on the marketplace app:
- **Impressions** — a set of impressions means such promotables have become visible to the consumer.
- **Clicks** — a click is sent to Topsort when the consumer has clicked on a promotable.
- **Purchases** — a purchase is sent to Topsort once a consumer places an order.

For promoted interactions, include the `resolvedBidId` field from the `/v2/auctions` response.
For unpromoted interactions, include the `entity` field to describe what was interacted with.
content:
application/json:
schema:
Expand Down
Loading