Skip to main content
GET
Shopping Products Over Time

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

Response

Daily product appearance counts

date
string<date>
required

UTC day (YYYY-MM-DD)

products
integer
required

Product appearances captured on the day