API Reference
Sources cited by the shopping answers of a topic
Pages cited in the answers, with the searches the surface ran behind them.
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
view?string
One row per cited page (url) or one row per store the pages sit on (domain).
Default
"url"Value in
- "url"
- "domain"
search?string
Case-insensitive match on the domain, the url or the page title.
Length
length <= 200startDate?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.
limit?number
skip?number
sortBy?string
Value in
- "totalAppearances"
- "lastSeenAt"
- "domain"
sortOrder?string
Value in
- "asc"
- "desc"
Response Body
application/json
curl -X GET "https://example.com/api/domains/string/topics/string/shopping/sources"{ "sources": [ { "url": "https://www.backmarket.fr/fr-fr/p/iphone-13", "domain": "backmarket.fr", "label": "iPhone 13 reconditionné", "description": "Reconditionné, garanti 12 mois", "isOwned": true, "totalAppearances": 12, "uniquePrompts": 3, "promptIds": [ "3fa85f64-5717-4562-b3fc-2c963f66afa6" ], "prompts": [ "meilleur iPhone reconditionné" ], "firstSeenAt": "2026-09-01T10:30:00.000Z", "lastSeenAt": "2026-09-15T10:30:00.000Z" } ], "totalSources": 42, "totalSearchQueries": 17, "uniqueDomains": 9, "dateRange": { "start": "2026-09-01T10:30:00.000Z", "end": "2026-09-15T10:30:00.000Z" }}