All parameters are query-string parameters on GET https://app.statsdrone.com/user/reports.
Required
Parameter | Format | Notes |
| string | Your API key from Settings |
|
| First day of the period |
|
| Last day of the period, included |
|
| Exactly these two values |
| see below | Which report to return |
groupBy accepts: accounts, brands, campaigns, variables, players, geo, postbacks. Anything else is rejected. variables and postbacks accept reportType=daily only.
Optional
Parameter | Format | Default | Notes |
| ISO 4217 code, e.g. | empty | Empty means every account keeps its own currency |
| comma-separated names | empty | Empty means no tag filter |
|
|
|
|
|
| off | Return your own brand/campaign labels instead of the program's names |
Notes on the optional four:
reportCurrencymust be a currency StatsDrone knows — the same list the Report currency dropdown offers. Converted amounts are rounded to 2 decimal places. If no exchange rate is available for an account's own currency, that account is not converted and itsinfo.currencykeeps naming the currency the numbers are actually in. Always readinfo.currencyrather than assuming the currency you asked for.tagsfilters on account tags for the Accounts, Dynamic Variables, Players, Geo and Postbacks reports, and on brand/campaign tags for the Brands and Campaigns reports. Send tag names with spaces removed.matchAny— any value other than the literalfalsebehaves astrue.labelsapplies to the Brands, Campaigns, Accounts, Dynamic Variables, Players and Geo reports. The Postbacks report ignores it: a postback's brand and campaign are values the affiliate program sent with the event, not names StatsDrone scraped, so there is nothing to relabel.
Date range limits
How far back. Both dates must be within the history your plan includes:
Plan | History available |
Freemium | last 12 months |
Starter | last 24 months |
Pro | last 36 months |
Enterprise, Custom, Dev, Trial | last 48 months |
These are the defaults. If your plan has been set up with its own history allowance, that one applies
instead — the Settings query builder and the API both use it.
A date outside that window is refused with an error naming the earliest date you can use.
How much at once. There is no page size and no limit parameter — one request returns one whole report. Instead there is a ceiling on the work a single request may do. A request that takes too long to build, or whose response would be very large, is refused with:
Your request exceeds the maximum data limit. Please split the date range into smaller periods.
If you hit it, ask for a shorter period and make several calls. The usual culprits are multi-month Players, Geo and Dynamic Variables requests on accounts with a lot of traffic.
Dates, times and time zones
dateFromanddateToare calendar dates, and both ends are included.Report dates are the dates the affiliate program reported the activity under. StatsDrone does not shift them into another time zone.
On the Postbacks report,
dateFrom/dateTocover whole days: from00:00:00on the start date to23:59:59on the end date.