---
title: "Store analytics by dimension"
method: GET
path: "/v1/analytics/breakdown"
tags: ["analytics"]
---

# Store analytics by dimension

`GET /v1/analytics/breakdown`

## Request

- Base URL: `https://api.octaneai.com`
- URL: `https://api.octaneai.com/v1/analytics/breakdown`
- Auth: HTTP bearer

## Query parameters

- `by` 'channel' | 'device' | 'new_returning' | 'country', required
- `from` string, date, nullable: First day, inclusive, in tz; 29 days before `to` when absent
- `to` string, date, nullable: Last day, inclusive, in tz; today when absent
- `tz` string
- `channel` string, nullable
- `device` string, nullable
- `new_returning` string, nullable
- `country` string, nullable

## Headers

- `if-none-match` string, nullable

## Response `200`

Analytics for the range. ETag identifies the cached response.

- AnalyticsBreakdown
  - `quiz_id` string, nullable, required: The quiz; null for every quiz of the store
  - `by` 'channel' | 'device' | 'new_returning' | 'country', required: The dimension the rows are grouped by
  - `range` AnalyticsRange, required
    - `start` string, date, required: First day of the range, inclusive, in timezone
    - `end` string, date, required: Last day of the range, inclusive, in timezone
    - `days` integer, required
    - `timezone` string, required: IANA name of the timezone the days are counted in; UTC unless the request named one
  - `filters` AnalyticsFilters, required
    - `channel` string, nullable, required: The channel filter applied: direct | organic_search | paid_search | organic_social | paid_social | email | sms | affiliate | display | paid_other | referral | ai_assistant | other | shared_results; null for all
    - `device` string, nullable, required: The device filter applied: mobile | tablet | desktop; null for all
    - `new_returning` string, nullable, required: The visitor filter applied: new | returning; null for all
    - `country` string, nullable, required: The country filter applied, ISO 3166-1 alpha-2; null for all
  - `freshness` Freshness, required
    - `as_of` string, date-time, nullable, required: When the numbers for past hours were last brought up to date, UTC ISO 8601; today's visits and orders are always counted live; null before the first update
    - `next_refresh_at` string, date-time, nullable, required: When the next update is due, UTC ISO 8601; null when none is scheduled or the numbers are read live
    - `stale` boolean, required
    - `pending` boolean, required: True until every update behind these numbers has run once, so they may be incomplete
    - `closed_days_through` string, date, required: The last day whose numbers are settled: yesterday in the request's timezone
    - `today_live` boolean, required
  - `rows` BreakdownRow[], required
    - `value` string, required: The group: a channel (direct | organic_search | paid_search | organic_social | paid_social | email | sms | affiliate | display | paid_other | referral | ai_assistant | other | shared_results), a device (mobile | tablet | desktop), new | returning, or a country code, per the breakdown's by
    - `views` integer, required: Visits that opened the quiz on the store, whether or not the shopper answered anything; previews are not counted
    - `starts` integer, required: Visits where the shopper answered or stepped forward at least once
    - `completions` integer, required: Visits that finished the quiz: reached its last page and answered whatever that page requires
    - `email_opt_ins` integer, required: Visits where the shopper submitted an email address
    - `phone_opt_ins` integer, required: Visits where the shopper submitted a phone number
    - `unique_viewers_approx` integer, required: An estimate of how many different people opened the quiz; someone who came back counts once

## Other responses

- `304`: If-None-Match matches the cached response; no body is sent.
- `401`: The key is missing, malformed, revoked or expired.
- `403`: The store's plan has no API access, or the key lacks the scope.
- `422`: A request parameter is invalid.
- `429`: The key's or the store's bucket is full; Retry-After says when to try again.
- `503`: Request limits could not be checked for the body, or the store's details could not be read.
- `504`: The request timed out.

---

[API](https://skmtc.dev/octaneai/apis/octane-ai-merchant-api.md) - [All operations](https://skmtc.dev/octaneai/apis/octane-ai-merchant-api/llms.txt) - [OpenAPI document](https://skmtc.dev/octaneai/apis/octane-ai-merchant-api/revisions/dc2d1aa2b7c6?raw)