List Shopping Product Appearances
Shopping
List Shopping Product Appearances
Paginated list of product appearances captured in AI shopping answers
GET
List Shopping Product Appearances
Authorizations
API key for authentication. Get yours from the Promptwatch dashboard under Settings > API Keys.
Query Parameters
Page number (1-based)
Required range:
x >= 1Page size
Required range:
1 <= x <= 100Search within product title or merchants
Exact (case-insensitive) product id in the source answer engine
Field to sort by
Available options:
createdAt, positionInResponse, rating, numReviews Sort order
Available options:
asc, desc Filter shopping data captured from this date (ISO 8601)
Filter shopping data captured until this date (ISO 8601)
Filter by LLM model IDs. Repeat for multiple: models=x&models=y
Filter by prompt type. Repeat for multiple values.
Available options:
ORGANIC, BRAND_SPECIFIC, COMPETITOR_COMPARISON Filter by prompt intent. Repeat for multiple values.
Available options:
BRANDED, INFORMATIONAL, NAVIGATIONAL, COMMERCIAL, TRANSACTIONAL