Skip to main content
GET
Get payment analytics

Authorizations

api_key
string
header
required

Personal API key.

Path Parameters

app_id
string
required

ID of the app whose payments to read.

Query Parameters

start_date
string<date-time> | null

First moment of the window, as an ISO 8601 timestamp. Send it together with end_date, because sending only one falls back to period and ignores the one you sent.

end_date
string<date-time> | null

Last moment of the window, as an ISO 8601 timestamp. Send it together with start_date.

period
enum<string>
default:30d

Window to use when you send no dates, counted back over whole UTC days including today. Either 7d, 30d or 90d.

Available options:
7d,
30d,
90d
currencies
string | null

Narrow the totals to these currencies, as a comma-separated list of three-letter ISO 4217 codes. Case does not matter. For example, usd,eur reports only those two. Take the values from available_currencies.

Response

The app's payment totals and daily series.

An app's payment totals and its day-by-day series.

summary
PaymentSummary · object
required

Totals across the whole window.

daily
DailyMetrics · object[]
required

One entry per day that had activity, oldest first. A day with no transactions is absent rather than zero-filled, so chart against the window you asked for rather than assuming a contiguous series.

Example:
available_currencies
string[]

Every currency the app took money in during the window, as lowercase three-letter ISO 4217 codes. Pass one or more of these back in currencies to narrow the totals to a single currency.

Example: