API Reference

Subscription activations

get
https://api.purchasely.io/management/v1/applications//dashboard_v2/subscription_activations

Subscription activations: how many subscriptions started in each period.

  • Returns an array of {period, group_by, group_by_public_id, group_by_name, total_activations_count} rows, one per period (and per group_by value when set).
  • Each subscription counts once, on its first activation event inside the chosen segment: direct purchase, free-trial/intro/promo start, or trial/intro/promo conversion to paid.
  • For segment=paid, only the first PAYING activation counts.
  • Reactivations, transfers and family-shared subscriptions are excluded.
  • Unit: count of subscriptions. A flow: summable across periods.
  • Recommended periodicity: MONTH, or WEEK for ranges under ~6 months.
  • Single application only.

Required scope: analytics.dashboards:view

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
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). Every time-series tool in this namespace needs it. Over REST, send it as date_range[]=2026-10-01&date_range[]=2026-10-25.

date_range[]*
string
enum

Bucket granularity. Defaults to MONTH. Use DAY for ranges up to ~60 days, WEEK up to ~6 months, MONTH beyond. Each row's period is the bucket's start date.

Allowed:
countries[]
array of strings

Filter by store country ISO codes.

countries[]
platform_names[]
array of strings

Filter by platform name.

platform_names[]
Allowed:
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[]
offer_types[]
array of strings

Filter by offer type.

offer_types[]
Allowed:
string

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

string

Filter by survey identifier.

string
enum

Split the series by one dimension. Omit for a single, ungrouped series. Values beyond the 10 largest groups are collapsed into one "Other" row. platform = store platform (ios, android, …); screen = paywall screen the subscription was purchased from; placement = placement the paywall was shown at; audience = audience the user matched; ab_test_variant = A/B test variant; plan = subscription plan; country = store country (ISO code); offer_types = offer type (NONE, FREE_TRIAL, INTRO_OFFER, PROMO_CODE, PROMOTIONAL_OFFER); payment_types = payment type (FULL_PRICE, PAID_OFFER, FREE_OFFER); period_types = plan billing period (P1W, P1M, P1Y, …); campaign = campaign; event_types = activation event (SUBSCRIPTION_STARTED, TRIAL_STARTED, TRIAL_CONVERTED, INTRO_OFFER_STARTED/CONVERTED, PROMO_CODE_STARTED/CONVERTED, PROMOTIONAL_OFFER_STARTED/CONVERTED).

string
enum

Restrict to a revenue segment. all = every subscription (default); paid = paying, at full price or on a paid (discounted) offer; full_price = paying the regular price; discounted = paying a reduced introductory/promotional price; free = on a free trial or free offer.

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

Updated 24 days ago

Did this page help you?
Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 24 days ago

Did this page help you?