API Reference
Shopping overview of a topic
The carousel KPIs against the preceding window, the share of shelf, the top products, the owned products positions and the merchants, over the answers to the prompts feeding shopping on this topic, split by your brand and its declared competitors.
AuthorizationBearer <token>
Session JWT signed with HS256. Verification pins the algorithm and rejects expired tokens, per RFC8725.
In: header
Path Parameters
domainId*string
topicId*string
Query Parameters
startDate?string
endDate?string
usedModels?string
Comma-separated shopping model ids to include (chatgpt, amazon-alexa-shopping).
tagIds?string
Comma-separated prompt tag ids; narrows the scope to the tagged prompts.
granularity?string
Value in
- "day"
- "week"
- "month"
Response Body
application/json
curl -X GET "https://example.com/api/domains/string/topics/string/shopping/overview"{ "kpis": {}, "shareOfShelf": {}, "topProducts": {}, "brandPositions": {}, "merchants": {}, "dateRange": {}, "market": "string", "language": "string", "topicName": "string"}