Retrieve Subscription Statistics (Daily)

Returns daily time-series data for one statistic metric across subscriptions matching the current subscription filters. The metric determines which dimension is queried: message metrics cover sends/opens/clicks/unsubscribes, subscription metrics cover signup lifecycle events, and campaign metrics cover campaign traffic/conversions/revenue. Campaign filters are effort-level filters used by campaign metrics and conversion-rate calculations; pass campaign_filters such as {"campaign_id":123} to scope campaign stats to a campaign.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
enum

Metric to chart. Message metrics: sends, opens, clicks, complaints, list_unsubscribes, unsubscribes, open_rate, click_rate. Subscription metrics: subscribers, new, duplicate, reactivate, renew, list_unsubscribes, unsubscriptions, prunes, hard_bounces, invalids, complaints; these count unique subscriptions per day. Campaign metrics: campaign_clicks, conversions, conversion_rate, revenue, epc, rpm. Defaults to a subscription metric.

string
enum

Statistics dimension used to interpret the metric. Defaults to subscription.

Allowed:
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

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

date

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

string

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

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 campaign metrics and conversion-rate calculations.

publication_id
array of integers

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

publication_id
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
LoadingLoading…
Response
Choose an example:
application/json