Retrieve Subscription Statistics (Aggregated)

get

https://{APP_DOMAIN}/api/3.2/subscriptions/statistics

Returns aggregated statistics for subscriptions by dimension. Use message for delivery and engagement stats, subscription for signup lifecycle stats, and campaign for campaign/conversion stats. Campaign stats are used on campaign detail pages when campaign_filters includes a campaign_id. Campaign filters are effort-level filters and are applied to the campaign dimension; message and subscription dimensions are based on the matching subscription set and do not apply campaign_filters.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

dimension

string

enum

Statistics dimension. message = delivery/engagement stats. subscription = signup lifecycle stats. campaign = campaign/conversion stats including visits, conversions, revenue, EPC, RPM, and conversion rate. Defaults to subscription.

Allowed:

date_range

string

Date range to include. Accepted values: today, yesterday, all, custom, or any number of days as Nd (for example 7d, 30d, 90d, 180d, 365d). When custom, provide date_from and/or date_to. Defaults to today.

date_from

date

Start date (inclusive) for a custom date_range, in the stats timezone. Only used when date_range is custom.

date_to

date

End date (inclusive) for a custom date_range, in the stats timezone. Only used when date_range is custom.

timezone

string

Optional IANA timezone used for date ranges. Defaults to the account reporting timezone.

advanced_query

string

JSON advanced query for subscriber search. Uses the same dynamic segment/subscriber search structure as the subscriptions table.

campaign_filters

string

JSON object of effort-level filters for campaign-scoped stats. Common keys include campaign_id, id, name, partner_id, publication_id, ad_id, message_id, auto_responder_id, effort_type_id, and type. Array values are treated as where-in filters. Applied to the campaign dimension.

publication_id

array of integers

Filter subscriptions by publication ID. Accepts a single value or an array.

publication_id

active

string

enum

Filter subscriptions by status: true for active, false for inactive, or lead for subscriptions without active status.

Allowed:

Response

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Choose an example:

application/json

200Aggregated statistics with totals, rates, signup counts, and campaign metrics. Only the selected dimension is populated; unused groups are returned empty.