v1

latestOpenAPI 3.1.02026-07-265897154.5 KB

Shopping

Get shopping visibility summary

AI shopping/product visibility (Peec-parity) — top products surfaced in AI shopping/product-carousel responses, ranked by mention volume, plus an activation-rate summary. Returns available:false (200, not an error) when the project has no shopping data yet. Returns 403 requiresUpgrade:true if the workspace's plan doesn't include Shopping Analytics (Scale+) and there is data to fetch. days defaults to 30, max 365.

get/api/mcp/projects/{projectId}/shopping

Path parameters

projectIdstring uuid required

The project id.

Query parameters

daysinteger

Lookback window in days. Default and maximum vary by endpoint — see the operation description.

platformstring

Comma-separated AI platform filter (e.g. chatgpt,claude,gemini). Accepted values and whether the param is required vary by endpoint — see the operation description.

Response

Shopping visibility summary.

availableboolean required

false (200, not an error) means no shopping/product data yet for this window — not a broken integration.

summaryobject nullable

Activation-rate summary — total window activation rate, response count, and product count. Null when available=false.

howToFixstring

Present only when available=false.