Skip to main content
GET
Get shopping visibility summary

Authorizations

Authorization
string
header
required

A Searchable API key, created under Settings → Workspace → Integrations. Send as Authorization: Bearer sea_xxxxx. Every key carries one or more scopes (read, write, admin) and may optionally be bound to a single project — see Getting started.

Path Parameters

projectId
string<uuid>
required

The project id.

Query Parameters

days
integer

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

Required range: x >= 1
platform
string

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.

available
boolean
required

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

products
object[]
required
dateRange
object
required

The resolved lookback window for this response.

summary
object | null

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

howToFix
string

Present only when available=false.