Overview
Operações
Overview daily deliveries
Delivered and failed counts per local day (App timezone, YYYY-MM-DD), zero-filled, plus the range totals.
Autorizações
Admin session cookie set by POST /v1/auth/login. Dashboard-only management.
Parâmetros
Parâmetros de Caminho
App ID
Parâmetros de Consulta
7d, 14d, 30d, 90d, or custom (default 14d)
Custom range start, YYYY-MM-DD (required when range=custom)
Custom range end (inclusive), YYYY-MM-DD (required when range=custom; from <= to, at most 366 days)
Respostas
OK
Overview device distribution
Active devices (subscribed, not deleted, seen in the last 30 days; not range-scoped) split by platform, country, app version, permission (granted/denied/provisional/not_determined) and OS major version. Country/version/OS keep the top 5 plus "other" (which also holds unknown values; its OS platform is null). below_min_version counts devices on an app version below the App's min_rich_push_version (0 when unset; unknown versions are not counted).
Autorizações
Admin session cookie set by POST /v1/auth/login. Dashboard-only management.
Parâmetros
Parâmetros de Caminho
App ID
Respostas
OK
Overview top failure reasons
Failed deliveries in the range (total) and the top 6 reason codes parsed from last_error: the APNs reason, the FCM errorCode, worker codes (provider_not_configured, app_disabled, device deleted) as-is, or "unknown".
Autorizações
Admin session cookie set by POST /v1/auth/login. Dashboard-only management.
Parâmetros
Parâmetros de Caminho
App ID
Parâmetros de Consulta
7d, 14d, 30d, 90d, or custom (default 14d)
Custom range start, YYYY-MM-DD (required when range=custom)
Custom range end (inclusive), YYYY-MM-DD (required when range=custom; from <= to, at most 366 days)
Respostas
OK
Overview engagement funnel
Sent → delivered → opened → clicked counts for the range, overall and per device platform, with the failed and pending deliveries that sent minus delivered lost. Opened counts a delivered delivery with an opened or clicked event. skipped_plan_limit counts the devices not sent to because the App was over its plan's MAU limit, for notifications created in the range.
Autorizações
Admin session cookie set by POST /v1/auth/login. Dashboard-only management.
Parâmetros
Parâmetros de Caminho
App ID
Parâmetros de Consulta
7d, 14d, 30d, 90d, or custom (default 14d)
Custom range start, YYYY-MM-DD (required when range=custom)
Custom range end (inclusive), YYYY-MM-DD (required when range=custom; from <= to, at most 366 days)
Respostas
OK
Overview engagement heatmap
168 weekday×hour cells (weekday 0 = Monday, hour 0–23, App timezone), zero-filled. sent = delivered deliveries dispatched in that cell; opened = those with an opened or clicked event; clicked = those with a clicked event.
Autorizações
Admin session cookie set by POST /v1/auth/login. Dashboard-only management.
Parâmetros
Parâmetros de Caminho
App ID
Parâmetros de Consulta
7d, 14d, 30d, 90d, or custom (default 14d)
Custom range start, YYYY-MM-DD (required when range=custom)
Custom range end (inclusive), YYYY-MM-DD (required when range=custom; from <= to, at most 366 days)
Respostas
OK
Overview In-App engagement
In-App engagement of the whole App over the range and the equal-length window before it (soft-deleted messages included, other Apps never): impressions, reach (distinct devices with an impression) and clicks with their change, CTR and dismiss rate (percentages over (message, device) pairs with an impression, in percentage points), a zero-filled daily series in the App's timezone, the top 10 messages by CTR among those with at least 20 impressions, the top 10 buttons by clicks, the taps on push_permission buttons and the top platform, app version and country of devices that saw a message. has_messages tells an App without messages from one without events in the range. reach_rate is reach over active_devices (subscribed devices seen in the last 30 days), capped at 100, and null when the range is longer than 30 days.
Autorizações
Admin session cookie set by POST /v1/auth/login. Dashboard-only management.
Parâmetros
Parâmetros de Caminho
App ID
Parâmetros de Consulta
7d, 14d, 30d, 90d, or custom (default 14d)
Custom range start, YYYY-MM-DD (required when range=custom)
Custom range end (inclusive), YYYY-MM-DD (required when range=custom; from <= to, at most 366 days)
Respostas
OK
Overview KPIs
Sent count, delivery rate (delivered/sent), open rate (opened/delivered), CTR (clicked/delivered) and In-App impressions for the range, each with the previous equal-length window, a delta (% for sent, null when prev is 0; percentage points for rates, null when the previous denominator is 0) and a per-day series in the App's timezone. Rates are 0–100 with one decimal.
Autorizações
Admin session cookie set by POST /v1/auth/login. Dashboard-only management.
Parâmetros
Parâmetros de Caminho
App ID
Parâmetros de Consulta
7d, 14d, 30d, 90d, or custom (default 14d)
Custom range start, YYYY-MM-DD (required when range=custom)
Custom range end (inclusive), YYYY-MM-DD (required when range=custom; from <= to, at most 366 days)
Respostas
OK
Overview CTR by template
Top 5 templates by CTR (clicked/delivered) among those with at least 100 deliveries in the range, with open rate and the previous window's CTR (null when it had no deliveries). has_more is true when more templates qualify. Ad-hoc notifications are excluded.
Autorizações
Admin session cookie set by POST /v1/auth/login. Dashboard-only management.
Parâmetros
Parâmetros de Caminho
App ID
Parâmetros de Consulta
7d, 14d, 30d, 90d, or custom (default 14d)
Custom range start, YYYY-MM-DD (required when range=custom)
Custom range end (inclusive), YYYY-MM-DD (required when range=custom; from <= to, at most 366 days)
Respostas
OK
Overview MAU usage
The App's rolling 30-day MAU against its Company plan's MAU limit, with the billing cycle (from renewal date and billing interval) and a linear end-of-cycle projection (mau × cycle_days / elapsed_days). plan_is_top_tier is true when the plan has the highest price in the catalog. Over the limit, skipped_users = mau - limit (users outside the push cap) and upgrade_plan_slug is the cheapest plan whose mau_limit covers mau and whose apps/users ceilings cover the Company's current Apps and members (null when within the limit or when no plan covers all three). 404 billing_unavailable on self-hosted deployments; license-server failures surface like the billing endpoints.
Autorizações
Admin session cookie set by POST /v1/auth/login. Dashboard-only management.
Parâmetros
Parâmetros de Caminho
App ID
Respostas
OK