Returns top brands for a custom category over a weekly date range, with optional domain filters and metric selection.

Request parameters

• asc query · optional

  Orders the results by ascending or descending

• category_id query · required

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

• domains query · optional

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

• end_date query · required

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

• format query · optional

  Format in which the reply should be returned

• granularity query · optional

  Time granularity for the returned values

• limit query · optional

  Sets how many results to return.

• market_code query · optional

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

• metrics query · optional

  Optional comma-separated list of fields to return: views, number_of_skus. When omitted, all fields are returned. Unselected fields are returned as null. The domain and brand_name fields are always included and are not controlled by this parameter.

• mtd query · optional

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

• offset query · optional

  Defines the number of results to skip

• sort query · optional

  Selects a specific metric to order results by

• start_date query · required

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