Getting Started

Sections

Brand Performance

Returns weekly brand performance metrics by domain for a custom category and brand.

Variants:

Time-series (this endpoint): GET /v5/retail-cross-performance/brands/performance — data broken down by date for trend analysis.
Aggregated: GET /v5/retail-cross-performance/brands/performance/aggregated — a single summary across the entire date range.

Both variants accept the same input parameters. The time-series response includes a date field per record; the aggregated response omits it and returns one consolidated row.

Possible output fields:

date: Weekly bucket start date (YYYY-MM-DD) for the brand performance row. (time-series only)
domain: Retailer domain for the brand performance row (e.g., 'amazon.com').
views: Estimated product page views for the selected brand in the row context.
number_of_skus: Number of SKUs for the selected brand in the row context.
category_views: Category views for the row context.
category_number_of_skus: Category number of SKUs for the row context.
views_share: Brand views share relative to category.

Constraints:

Required parameters: start_date, end_date, category_id, brand_name
Allowed values for granularity: weekly
mtd=true is only supported with weekly granularity

This endpoint uses data credits. See the data credits guide to estimate costs.

Header Parameters

api-keystring

Query Parameters

granularitystring

Time granularity for the returned values

Enum values:

weekly

start_datestring Required

Start date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago

end_datestring Required

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago

metricsarray

Comma-separated metrics: domain, views, number_of_skus, category_views, category_number_of_skus, views_share.

Style

form

Enum values:

domainviewsnumber_of_skuscategory_viewscategory_number_of_skusviews_share

mtdboolean

When true with weekly granularity, end_date is set to the latest available Saturday. NOT supported for monthly granularity.

category_idstring Required

Custom category UUID from the describe endpoint's custom_categories list (required on analytics endpoints).

domainsarray

Optional comma-separated retailer domains (without 'www.') to restrict results. Use categories/domains or describe category filters to discover valid domains.

Style

form

market_codestring

Optional two-letter market code (e.g., 'us', 'uk'). Omit to include all markets. Use describe to list supported values.

brand_namestring Required

Brand name to analyze.

formatstring

Format in which the reply should be returned

Enum values:

jsonxml

limitinteger

Sets how many results to return.

offsetinteger

Defines the number of results to skip

ascboolean | null

Orders the results by ascending or descending

sortstring

Selects a specific metric to order results by

Response

200

Object

Response Attributes

metaobject

Show child attributes

dataarray | null

Show child attributes

Sections

Brand Performance

Header Parameters

Query Parameters

ResponseExpand all

Response Attributes

Response

Ask an AI

Code with AI

Response