Live subscription and user status

get

https://api.purchasely.io/management/v1/applications/{application_id}/dashboard/header_live

Live header cards (active-subscriptions statuses, live users, inactive-subscriptions causes) for an application, or across every application you can access. The Purchasely console (including Ask your data) and Purchasely staff get all three cards. API keys and third-party MCP clients get one card per call, and never live users. Live users take up to 80 s on large apps.

Required scope: analytics.dashboards:view

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

application_id

string

required

Public ID of the resource.

Query Params

date_range[]

array of strings

required

Two-element [start_date, end_date] window of ISO8601 dates (YYYY-MM-DD); both ends inclusive (the end date's events are counted). Over REST, send it as date_range[]=2026-10-01&date_range[]=2026-10-25.

date_range[]*

countries[]

array of strings

Filter by store country ISO codes (or "Unknown").

countries[]

platform_names[]

array of strings

Filter by platform name.

platform_names[]

Allowed:

period_types[]

array of strings

Filter by plan billing period, as an ISO 8601 duration (e.g. P1W, P1M, P1Y).

period_types[]

plans[]

array of strings

Filter by subscription plan public_id.

plans[]

family_sharing[]

array of strings

Filter by family-sharing flag ("true"/"false" strings).

family_sharing[]

offer_types[]

array of strings

Filter by offer type.

offer_types[]

Allowed:

promotional_offers[]

array of strings

Filter by promotional offer public_id.

promotional_offers[]

audiences[]

array of strings

Filter by audience public_id.

audiences[]

campaigns[]

array of strings

Filter by campaign public_id.

campaigns[]

placements[]

array of strings

Filter by placement public_id.

placements[]

screens[]

array of strings

Filter by screen (paywall) public_id.

screens[]

ab_test_variants[]

array of strings

Filter by A/B test variant public_id.

ab_test_variants[]

unique_users

string

Restrict to unique users ("true"/"false").

survey

string

Filter by survey identifier.

category

string

enum

The header card to return. active_subscriptions_statuses = active subscriptions split by status; active_subscribers = live users; inactive_subscriptions_causes = inactive subscriptions split by cause. API keys and third-party MCP clients must send it, and cannot ask for active_subscribers. Live users are too slow on large apps. The Purchasely console and Purchasely staff may ask for any card, or omit it to receive all three.

Allowed:

fields[]

array of strings

Field selection for token economy: an explicit list of field names to include in the response, or ["*"] for every field. Omit for this endpoint's own default field set.

fields[]

Responses

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success.

403FORBIDDEN (missing/insufficient scope, wrong tenant) or, for feature-gated operations, FEATURE_NOT_ENABLED.

422VALIDATION_FAILED — one or more parameters were missing or invalid.

429RATE_LIMITED — the coarse per-key, per-write, per-heavy-read, or per-moderate-read rate limit tier was exceeded.

504QUERY_TIMEOUT — a database query took too long and was cancelled. Retry with narrower filters, for example a shorter date_range.