/api/v2/shoppingReturn shopping visibility overview.
Return shopping visibility overview.
Requires bearer API key
Parameters
X-Project-Id
header
Required for organization-wide API keys on project-scoped endpoints. Project-scoped keys infer the project automatically.
Schema: string
startDate
query
No description provided.
Schema: string:date-time
endDate
query
No description provided.
Schema: string:date-time
range
query
Shortcut for the last 7 or 90 days. Date filters take precedence when present.
Schema: string (7, 90)
q
query
Product-name search. Alias: productSearch.
Schema: string
productSearch
query
Alias for q product-name search.
Schema: string
merchant
query
Single merchant-domain filter used by the workspace UI.
Schema: string
merchantDomains
query
Comma-separated merchant domains are accepted.
Schema: string
response
query
Filter to product cards extracted from one persisted response. Alias: responseId.
Schema: string
responseId
query
Alias for response.
Schema: string
monitorIds
query
Comma-separated values are accepted.
Schema: string
modelIds
query
Comma-separated values are accepted.
Schema: string
Responses
Successful JSON response.
application/json{
"type": "object",
"additionalProperties": false,
"properties": {
"totalItems": {
"type": "integer"
},
"totalProducts": {
"type": "integer"
},
"totalMerchants": {
"type": "integer"
},
"avgPosition": {
"type": "number",
"nullable": true
},
"positionSeries": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"date": {
"type": "string"
},
"avgPosition": {
"type": "number",
"nullable": true
}
},
"required": [
"date",
"avgPosition"
]
}
},
"topProducts": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"productName": {
"type": "string"
},
"appearances": {
"type": "integer"
},
"avgPosition": {
"type": "number",
"nullable": true
}
},
"required": [
"productName",
"appearances",
"avgPosition"
]
}
},
"topMerchants": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"merchantDomain": {
"type": "string"
},
"appearances": {
"type": "integer"
}
},
"required": [
"merchantDomain",
"appearances"
]
}
},
"productBars": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"productName": {
"type": "string"
},
"appearances": {
"type": "integer"
},
"avgPosition": {
"type": "number",
"nullable": true
}
},
"required": [
"productName",
"appearances",
"avgPosition"
]
}
}
},
"required": [
"totalItems",
"totalProducts",
"totalMerchants",
"avgPosition",
"positionSeries",
"topProducts",
"topMerchants",
"productBars"
]
}Try it
Send this request to the local WatchLLM REST handler. Use a key from `/workspace/api`; organization keys can include `X-Project-Id` only when the endpoint documents that header.