---
title: "Get Analytics Overview"
method: GET
path: "/reports/overview"
---

# Get Analytics Overview

`GET /reports/overview`

## Request

- Base URL: `https://api.web2wave.com/api`
- URL: `https://api.web2wave.com/api/reports/overview`
- Auth: API key in header `api_key`

Returns the same data as the cabinet Analytics "Overview" tab for the project of the API key:
KPI numbers for the period (`period`), the same numbers for the previous period of equal length
(`previous_period`, `previous_period_dates`) and the chart series (`overview`).
`from`/`to` are interpreted in the project timezone; defaults to the last 30 days.

`overview.granularity` is `hour` when the period is shorter than 48 hours, otherwise `day`.
`overview.series` is keyed by metric id; the metric list, labels and the matching `period` key
(`period_key`) are available in `catalog.overview_metrics` of `GET /reports/chart-builder/catalog`.
For a single metric broken down by any dimension use `GET /reports/chart-builder`.

## Query parameters

- `from` string, date
- `to` string, date
- `quizzes` union
  - string[]
  - string: Comma-separated values
- `paywalls` union
  - string[]
  - string: Comma-separated values
- `utm_source` union
  - string[]
  - string: Comma-separated values
- `utm_medium` union
  - string[]
  - string: Comma-separated values
- `utm_campaign` union
  - string[]
  - string: Comma-separated values
- `utm_content` union
  - string[]
  - string: Comma-separated values
- `utm_term` union
  - string[]
  - string: Comma-separated values
- `payment_system` integer
- `user_country_code` string
- `user_platform` string
- `experiment_id` integer
- `experiment_variant` integer
- `user_property` string
- `user_property_value` string

## Headers

- `api_key` string, required

## Response `200`

Overview data

- object
  - `success` boolean
  - `from` string, date-time
  - `to` string, date-time
  - `period` object: KPI numbers for the selected period (revenue, subscriptions, funnel counts, conversions in percent, ARPU/ARPPU). Also `spend` (Meta Ads spend in USD of the project's active ad accounts whose utm_source occurs in the project's visits, as in the Table Report; `null` without an ad account), `spend_unattributed` (the rest of those accounts' spend: other products in a shared ad account, ads without UTM tags), `has_ad_accounts` (boolean) and `predicted_revenue_367d` (what the period's subscriptions will have earned 367 days after they started, revenue so far plus the platform's LTV prediction; `null` when LTV predictions are off or cover too few of the subscriptions; `predicted_revenue_32d` ... `_279d` the same at the other horizons), `proas_367d` (`predicted_revenue_367d` / `spend`) and `payback_days` (day the period's predicted cumulative revenue reaches `spend`; `null` with `payback_beyond_year` true when not within a year, `null` without spend or predictions).
  - `previous_period` object: The same KPI numbers for the previous period of equal length.
  - `previous_period_dates` object
    - `from` string
    - `to` string
  - `overview` object
    - `granularity` 'hour' | 'day'
    - `labels` string[]: Bucket start (`YYYY-MM-DD` for day, `YYYY-MM-DD HH:00:00` for hour).
    - `series` object: Per-bucket values keyed by metric id (e.g. `total_revenue`, `buyers`, `users_count`).

## Other responses

- `403`: Invalid or incorrect api_key
- `422`: Validation error, or api_key missing / not set up for the project

## Changes

- **2026-11-03** `eb8b2d9124ac`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/web2wave/apis/web2wave-api/changes/reports/overview/get.md)

---

[API](https://skmtc.dev/web2wave/apis/web2wave-api.md) - [All operations](https://skmtc.dev/web2wave/apis/web2wave-api/llms.txt) - [OpenAPI document](https://skmtc.dev/web2wave/apis/web2wave-api/revisions/eb8b2d9124ac?raw)