WEweb2wave

Get Analytics Overview

Changed on

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.

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

Query parameters

fromstring date

Start date (YYYY-MM-DD, project timezone). Defaults to 29 days ago.

tostring date

End date (YYYY-MM-DD, project timezone). Defaults to today.

string[]
OR
string

Comma-separated values

Limit to quiz ids.

string[]
OR
string

Comma-separated values

Limit to paywall ids.

string[]
OR
string

Comma-separated values

Filter by utm_source values.

string[]
OR
string

Comma-separated values

Filter by utm_medium values.

string[]
OR
string

Comma-separated values

Filter by utm_campaign values.

string[]
OR
string

Comma-separated values

Filter by utm_content values.

string[]
OR
string

Comma-separated values

Filter by utm_term values.

payment_systeminteger

Filter by payment system id.

user_country_codestring

Filter by user country code.

user_platformstring

Filter by user platform.

experiment_idinteger

Filter by experiment id.

experiment_variantinteger

Experiment variant (used with experiment_id, default 0).

user_propertystring

User property name to filter by (with user_property_value).

user_property_valuestring

User property value.

Headers

api_keystring required

API key for authentication

Response

Overview data

successboolean
fromstring date-time
tostring date-time
periodobject

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_periodobject

The same KPI numbers for the previous period of equal length.

Example response

{
  "success": true,
  "previous_period_dates": {
    "from": "2023-12-02 00:00:00",
    "to": "2023-12-31 23:59:59"
  }
}

Changes