analytics

Products attributed to the store's quizzes

get/v1/analytics/products

Request

limitinteger

bucket'added_from_quiz' | 'shown_bought_later' | 'bought_not_shown' nullable

sort'revenue' | 'units' | 'orders'

fromstring date nullable

First day, inclusive, in tz; 29 days before to when absent

tostring date nullable

Last day, inclusive, in tz; today when absent

tzstring

if-none-matchstring nullable

Analytics for the range. ETag identifies the cached response.

quiz_idstring nullable required

The quiz; null for every quiz of the store

bucket'added_from_quiz' | 'shown_bought_later' | 'bought_not_shown' nullable required

The how-it-was-bought group the rows and totals are narrowed to; null for all

sort'revenue' | 'units' | 'orders' required

total_productsinteger required

How many different products appear in linked orders in the range, within bucket when set

orders_matched_by_emailinteger required

Linked orders in the range matched by the email the shopper gave

{
  "quiz_id": "quiz_7c9e6679742540de944be07fc1f90ae7",
  "rows": [
    {
      "product_id": "gid://shopify/Product/8692896989320"
    }
  ]
}

No recorded changes to this operation across all 1 revision of this API.