Get payment analytics
Returns what an app earned: the totals for a window, and a day-by-day series you can chart.
Money is reported in the smallest unit of the currency, so 125000 is 1,250.00 where the currency has two decimal places. Read net_revenue for what the app actually kept, since gross_revenue counts refunded and disputed payments too.
Set the window with start_date and end_date, which you must send together. With neither, period picks the last 7, 30 or 90 whole UTC days including today, and 30 is the default. Sending only one of the two dates falls back to period and silently ignores the date you sent, so send both or neither.
currencies is dropped rather than rejected, and if every code you send is unusable the response comes back as zeros rather than an error. Send lowercase three-letter codes taken from available_currencies.Only live money is counted. Payments an app took while its payment provider was still in test mode are excluded.
Authorizations
Personal API key.
Path Parameters
ID of the app whose payments to read.
Query Parameters
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.
Last moment of the window, as an ISO 8601 timestamp. Send it together with start_date.
Window to use when you send no dates, counted back over whole UTC days including today. Either 7d, 30d or 90d.
7d, 30d, 90d 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.
Totals across the whole window.
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.
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.