Skip to main content
GET
Shopping Product Position Analytics

Authorizations

X-API-Key
string
header
required

API key for authentication. Get yours from the Promptwatch dashboard under Settings > API Keys.

Query Parameters

from
string<date-time>

Filter shopping data captured from this date (ISO 8601)

until
string<date-time>

Filter shopping data captured until this date (ISO 8601)

models

Filter by LLM model IDs. Repeat for multiple: models=x&models=y

promptTypes

Filter by prompt type. Repeat for multiple values.

Available options:
ORGANIC,
BRAND_SPECIFIC,
COMPETITOR_COMPARISON
intentTypes

Filter by prompt intent. Repeat for multiple values.

Available options:
BRANDED,
INFORMATIONAL,
NAVIGATIONAL,
COMMERCIAL,
TRANSACTIONAL
limit
integer
default:8

Maximum number of entries to return

Required range: 1 <= x <= 20

Response

Default Response

topProducts
object[]
required

Top products by appearances

timeSeries
object[]
required

Daily positions for the top products