get/api/v2/shopping
Return shopping visibility overview.
Return shopping visibility overview.
Requires bearer API keyParameters
| Name | In | Description |
|---|---|---|
| X-Project-Id | header | Required for organization-wide API keys on project-scoped endpoints. Project-scoped keys infer the project automatically.string |
| startDate | query | No description provided.string:date-time |
| endDate | query | No description provided.string:date-time |
| range | query | Shortcut for the last 7 or 90 days. Date filters take precedence when present.string (7, 90) |
| q | query | Product-name search. Alias: productSearch.string |
| productSearch | query | Alias for q product-name search.string |
| merchant | query | Single merchant-domain filter used by the workspace UI.string |
| merchantDomains | query | Comma-separated merchant domains are accepted.string |
| response | query | Filter to product cards extracted from one persisted response. Alias: responseId.string |
| responseId | query | Alias for response.string |
| monitorIds | query | Comma-separated values are accepted.string |
| modelIds | query | Comma-separated values are accepted.string |
Responses
200
application/jsonSuccessful JSON response.
{
"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.