---
title: "Store analytics summary"
method: GET
path: "/v1/analytics/summary"
tags: ["analytics"]
---

# Store analytics summary

`GET /v1/analytics/summary`

## Request

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

## Query parameters

- `period` '7d' | '30d'
- `tz` string

## Headers

- `if-none-match` string, nullable

## Response `200`

Analytics for the range. ETag identifies the cached response.

- AnalyticsSummary
  - `period` '7d' | '30d', required
  - `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
  - `previous_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
  - `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
  - `views` SummaryCount, required
    - `current` integer, required: The count over the current period
    - `previous` integer, required: The count over the period of the same length just before it
    - `delta_pct` number, nullable, required: The change from previous to current as a percentage of previous; null when previous is zero
    - `sparkline` integer[], required: The current period in seven points, oldest first: one day each over 7 days, four or five days each over 30
  - `starts` SummaryCount, required
    - `current` integer, required: The count over the current period
    - `previous` integer, required: The count over the period of the same length just before it
    - `delta_pct` number, nullable, required: The change from previous to current as a percentage of previous; null when previous is zero
    - `sparkline` integer[], required: The current period in seven points, oldest first: one day each over 7 days, four or five days each over 30
  - `completions` SummaryCount, required
    - `current` integer, required: The count over the current period
    - `previous` integer, required: The count over the period of the same length just before it
    - `delta_pct` number, nullable, required: The change from previous to current as a percentage of previous; null when previous is zero
    - `sparkline` integer[], required: The current period in seven points, oldest first: one day each over 7 days, four or five days each over 30
  - `opt_ins` SummaryCount, required
    - `current` integer, required: The count over the current period
    - `previous` integer, required: The count over the period of the same length just before it
    - `delta_pct` number, nullable, required: The change from previous to current as a percentage of previous; null when previous is zero
    - `sparkline` integer[], required: The current period in seven points, oldest first: one day each over 7 days, four or five days each over 30
  - `orders` SummaryCount, required
    - `current` integer, required: The count over the current period
    - `previous` integer, required: The count over the period of the same length just before it
    - `delta_pct` number, nullable, required: The change from previous to current as a percentage of previous; null when previous is zero
    - `sparkline` integer[], required: The current period in seven points, oldest first: one day each over 7 days, four or five days each over 30
  - `revenue` SummaryMoney, required
    - `current` Money, required
      - `amount` string, required: A decimal string, as "79.97"
      - `currency` string, required: ISO 4217 code
    - `previous` Money, required
      - `amount` string, required: A decimal string, as "79.97"
      - `currency` string, required: ISO 4217 code
    - `delta_pct` number, nullable, required: The change from previous to current as a percentage of previous; null when previous is zero
    - `sparkline` Money[], required: The current period in seven points, oldest first: one day each over 7 days, four or five days each over 30
      - `amount` string, required: A decimal string, as "79.97"
      - `currency` string, required: ISO 4217 code

## 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)