Skip to main content
GET
Get Shopping Timeseries

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

organization_id
string
required
workspace_id
string
required
project_id
string
required

Query Parameters

date_start
string<date>
required

Start of the date range (YYYY-MM-DD).

date_end
string<date>
required

End of the date range (YYYY-MM-DD, inclusive).

brands
string[] | null

Restrict results to products whose catalogue brand matches one of these brand names.

product_catalog_ids
string[] | null

Restrict results to products linked to one of these product catalogue IDs.

merchants
string[] | null

Restrict results to products offered by one of these merchant brand names.

sources
enum<string>[] | null
Available options:
Bing,
BingAIO,
ChatGPT,
Perplexity,
Google,
GoogleAIO,
GoogleAIMode,
Claude,
Gemini,
AmazonRufus
thematics
string<uuid>[] | null

Filter by a list of thematic IDs

keyword_type
enum<string>[] | null

Filter by a list of keyword types

Available options:
Generic,
Brand
funnel_stages
enum<string>[] | null

Filter by a list of Funnel Stages

Available options:
ToFu,
MoFu,
BoFu
persona_ids
string[] | null

Filter by a list of persona IDs

topic_ids
string[] | null

Filter by a list of topic IDs

get_neutrals
boolean | null

Filter by to get results related to neutral prompts, without weakness or strength

strength_ids
string[] | null

Filter by a list of strength IDs

weakness_ids
string[] | null

Filter by a list of weakness IDs

Response

Successful Response

collection_date
string
required

Collection date in YYYY-MM-DD format.

engine
string
required

Search engine source.

products_count
integer
required

Number of distinct unified products.

results_count
integer
required

Total product rows across all tracked keywords and sources.

brands_count
integer
required

Number of distinct brands from merchant offers.

merchants_count
integer
required

Number of distinct merchants from offers.

share_of_shelf
number
required

Share of total shopping result rows for this day, expressed as a percentage. Computed as (results_count / day_total_results) × 100.