Log an ad impression or click
Records an impression or click beacon for a sponsored placement. Requires a marketplace operator key.
This is fire-and-forget: fire one impression per placement when it becomes visible, and a
click when the shopper clicks it. Pass the booking_id from the placement you rendered.
The response returns 202 Accepted with billable indicating whether the event counted
toward billing after de-duplication and invalid-traffic filtering. This is informational —
the storefront does not need to act on it.
curl --request POST \
--url https://api.tybritelabs.com/v1/marketplace/ad-events \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"booking_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"event_type": "impression",
"session_id": "sess_abc123"
}
'{
"recorded": true,
"billable": true
}{
"error": {
"code": "invalid_request",
"message": "Invalid request parameters",
"details": "The 'email' field is required"
}
}{
"error": {
"code": "unauthorized",
"message": "Missing or invalid Authorization header"
}
}{
"error": {
"code": "forbidden",
"message": "This operation requires a secret key. Publishable keys cover catalogue reads and the actions a shopper takes for themselves."
}
}{
"error": {
"code": "server_error",
"message": "An unexpected error occurred"
}
}Authorizations
API Key Authentication
Use your API key in the Authorization header:
Authorization: Bearer tybrite_sk_live_YOUR_KEY
Key Types:
Secret Keys (Server-Side Only):
- Format:
tybrite_sk_live_*(production) ortybrite_sk_test_*(sandbox) - Full read/write access to all endpoints
- ⚠️ NEVER expose in client-side code or public repositories
- Required for: every write a shopper does not make for themselves, authentication, payment verification, AI recommendations
Publishable Keys (Client-Safe):
- Format:
tybrite_pk_live_*(production) ortybrite_pk_test_*(sandbox) - Catalogue reads, plus the actions a shopper takes for themselves
- ✅ Safe for client-side JavaScript, mobile apps, and public code
- Allowed for: browsing products, search, CMS content, pricing queries, cart and wishlist, reviews, storefront events, and the Agent API's quotes, cart drafts and checkout intents
Endpoint-Specific Requirements:
- Authentication endpoints (
/v1/auth/*): Secret key required - Payment verification (
POST /v1/payments/verify): Secret key required - AI Recommendations (
POST /v1/recommendations): Secret key required - Semantic Search (
POST /v1/search): Both key types allowed (read-only operation) - Shopper actions (cart, wishlist, reviews, storefront events, Agent API quotes, cart drafts and checkout intents): Both key types allowed
- All other write operations: Secret key required
- All read operations: Both key types allowed
Using a publishable key for restricted operations returns 403 Forbidden.
Body
The placement's identifier, taken from the slot response.
Whether the placement was shown (impression) or clicked (click).
impression, click Optional — the specific product within the placement the event relates to.
Optional — an opaque storefront session identifier used to de-duplicate events.
Response
The beacon was accepted.
curl --request POST \
--url https://api.tybritelabs.com/v1/marketplace/ad-events \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"booking_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"event_type": "impression",
"session_id": "sess_abc123"
}
'{
"recorded": true,
"billable": true
}{
"error": {
"code": "invalid_request",
"message": "Invalid request parameters",
"details": "The 'email' field is required"
}
}{
"error": {
"code": "unauthorized",
"message": "Missing or invalid Authorization header"
}
}{
"error": {
"code": "forbidden",
"message": "This operation requires a secret key. Publishable keys cover catalogue reads and the actions a shopper takes for themselves."
}
}{
"error": {
"code": "server_error",
"message": "An unexpected error occurred"
}
}