Skip to main content
GET
Get analytics chart data

Authorizations

Authorization
string
header
required

Bearer authentication using the project Secret Key (prefixed with sk_, or test_sk_ for sandbox). All v4 public endpoints require the Secret Key — see Authentication. Never expose the Secret Key in client-side code.

Path Parameters

chart_code
enum<string>
required

Chart code. Only the codes listed in the endpoint description are exposed publicly; others return 404.

Available options:
proceeds,
active-subscriptions,
paid-subscriptions-movement,
users-overview,
free-trials,
active-trials,
trials-movement,
user-to-trial,
trial-to-paid,
user-to-paid,
sales,
refunds,
refund-rate,
arppu,
arpu,
trial-cancellation,
subscription-cancellation,
subscriptions-overview,
new-subscriptions,
mrr,
arr,
mrr-movement,
arr-movement,
user-to-trial-conversion,
subscription-cancellation-rate
Maximum string length: 64

Query Parameters

from
integer<int64>

Start of the time range (Unix timestamp, seconds). Default is 7 days before to.

to
integer<int64>

End of the time range (Unix timestamp, seconds). Default is the current time.

unit
enum<string>
default:day

Time bucket size. hour requires a short range; month is used for long-range trends.

Available options:
hour,
day,
week,
month
environment
enum<integer>
default:1

Environment: 0 = sandbox, 1 = production.

Available options:
0,
1
max_series
integer
default:50

Upper bound on the number of segmentation series returned. Clamped to 0..500 on the upstream.

Required range: 0 <= x <= 500
segmentation
string

Attribute to split the chart into segments (e.g. country, target_platform, product_id). Not all charts support every segmentation — see */meta.

currency
string
default:USD

Three-letter ISO 4217 currency code for monetary charts. Defaults to USD. The list of supported codes is GET /v4/analytics/currencies.

Pattern: ^[A-Z]{3}$
filter[<attribute>][]
string[]

Attribute-scoped filter (repeat the parameter once per value). Each attribute is ANDed with every other attribute; values within the same attribute are ORed.

Examples:

  • filter[country][]=US&filter[country][]=GB — US or UK
  • filter[country][]=US&filter[target_platform][]=iOS — US and iOS
  • filter[product_id][]=premium_monthly&filter[product_id][]=premium_yearly

Attribute codes are stable across projects; their value lists are project-scoped and discoverable from the chart's */meta response (filter_conditions[].attribute / filter_conditions[].values[]). Common attribute codes:

Scalar attributes (user_id, q_user_id, device_id) accept a single value; list attributes accept many. Up to 50 distinct attributes and 100 values per attribute are accepted; the rest are silently dropped.

Response

Chart data.

object
enum<string>
required
Available options:
analytics_chart
url
string
required

Canonical URL for this chart query.

code
string
required

Chart code, echoed from the request.

from
integer<int64>
required
to
integer<int64>
required
unit
enum<string>
required
Available options:
hour,
day,
week,
month
environment
enum<integer>
required
Available options:
0,
1
measure
enum<string>
required

Physical unit of series[].data[].value.

Available options:
usd,
count,
percent
totalType
enum<string>
required

How series[].total is computed.

Available options:
sum,
wavg
seriesRelation
enum<string>
required
  • partsOfWhole — series add up to a meaningful total (e.g. revenue by country).
  • independent — series are not directly comparable in sum.
Available options:
partsOfWhole,
independent
maxSeries
integer
required

Max number of series the server may emit.

series
object[]
required
currency
string

ISO 4217 currency code used for monetary values.

horizontalLabelType
string

Hint for the UI on how to format X-axis labels.

segmentation
string | null

Segmentation dimension used, if any.

summarySeries
object | null