Skip to main content
All CollectionsIntegrationsStatsDrone Data API
StatsDrone Data API Documentation
StatsDrone Data API Documentation

Detailed documentation for using the StatsDrone Data API

Joe Hatch avatar
Written by Joe Hatch
Updated over a week ago

Data API is a custom feature available available as an additional add-on in your account and is a paid feature. If your current subscription does not have API data export enabled, you will have to upgrade your plan.

Data API is a custom feature available available as an additional add-on in your account and is a paid feature. If your current subscription does not have API data export enabled, you will have to upgrade your plan.

StatsDrone Data API (via app)

Objective:

Currently built-in to our application, we have Data Feed Management. This enables the API data feed at a StatsDrone account level. There is one API Key that is issued for the account which authenticates users to request data from our services stored within the app database.

Request Structure:

Required Parameters:

  • API Key: this is a unique API Key to authenticate the user account.

  • Start Date: (YYYY-MM-DD format) The date on which the requested statistical data should start

  • End Date: (YYYY-MM-DD format) The date on which the requested statistical data should end

  • Report breakdown: Select how the requested statistical data should be broken down.

    • By Dates

    • By Months

  • Group data by: How the data should be grouped in the response

    • Accounts

    • Brands

    • Campaigns

Optional Parameters:

  • Report Currency: Select the currency to which all of the monetary values will be converted to. If you leave this field empty, the monetary values for each affiliate account will be shown in their corresponding currency.

  • Tags Filter: Filter the requested statistical data by the affiliate account, brand or campaign tags that you’ve set in your StatsDrone reports. Which type of tags (account/brand/campaign) are going to be used to filter by depends on the “Group data by” parameter that you’ve set. If you leave this field empty, you’ll get all of your data included regardless of any tags that might be present.

Example request:

https://app.statsdrone.com/user/reports?apiKey=<APIKEY>&dateFrom=<YYYY-MM-DD>&dateTo=<YYYY-MM-DD>&reportType=<daily|monthly>&reportCurrency=<currency>&groupBy=<accounts|brands|campaigns>&tags=<tag1,tag2,tag3>

Supported Currencies:

  1. Argentine Peso (ARS $)

  2. Australian Dollar (AUD $)

  3. Bitcoin (BTC Ƀ)

  4. Brazilian Real (BRL R$)

  5. British Pounds (GBP £)

  6. Brunei Dollar (BND $)

  7. Bulgarian Lev (BGN лв)

  8. Canadian Dollar (CAD $)

  9. Cardano (ADA ₳)

  10. Chile Peso (CLP $)

  11. China Yuan Renminbi (CNY ¥)

  12. Colombian Peso (COP $)

  13. Croatian Kuna (HRK kn)

  14. Czech Koruna (CZK Kč)

  15. Danish Krone (DKK kr)

  16. Dogecoin (DOGE Ð)

  17. Ethereum (ETH Ξ)

  18. Ethereum Classic (ETC ξ)

  19. Euro (EUR €)

  20. Hong Kong Dollar (HKD $)

  21. Hungarian Forint (HUF Ft)

  22. Icelandic Krona (ISK Íkr)

  23. Indian Rupee (INR ₹)

  24. Japanese Yen (JPY ¥)

  25. Litecoin (LTC Ł)

  26. Malaysia Ringgit (MYR RM)

  27. mBitcoin (mBTC mɃ)

  28. Mexican Peso (MXN $)

  29. Monero (XMR ɱ)

  30. Nano (XNO Ӿ)

  31. New Zealand Dollar (NZD $)

  32. Nigerian Naira (NGN ₦)

  33. Norwegian Krone (NOK kr)

  34. Polish Zloty (PLN zł)

  35. Ripple (XRP ✕)

  36. Romanian New Leu (RON lei)

  37. Russian Ruble (RUB руб)

  38. Singapore Dollar (SGD $)

  39. Solana (SOL ◎)

  40. South African Rand (ZAR R)

  41. South Korean Won (KRW ₩)

  42. Swedish Krona (SEK kr)

  43. Swiss Franc (CHF CHF)

  44. Tether (USDT ₮)

  45. Turkish Lira (TRY ₺)

  46. Ukrainian Hryvnia (UAH ₴)

  47. US Dollar (USD $)

  48. Vietnamese Dong (VND ₫)

  49. Zcash (ZEC ⓩ)

API Response Structure

Root Object

  • success: (boolean) Indicates whether the API request was successful.

  • data: (object) Contains the main data returned by the API.

Data Object

The data object contains key-value pairs where each key represents a campaign name, and the value is an object containing campaign details.

Campaign Object

Each campaign object contains:

  • info: (object) Contains metadata about the campaign.

  • currency: (string) The currency used for the campaign.

  • date objects: (object) Each date (formatted as YYYY-MM-DD) contains statistics for that specific day.

Date Object

Each date object contains:

  • date: The date for the reported data (formatted as YYYY-MM-DD).

  • raw_clicks: The total number of raw clicks.

  • unique_clicks: The total number of unique clicks

  • impressions: The total number of impressions (stored as a string in the provided example but should be an integer).

  • signups: The total number of signups.

  • first_time_deposits: The number of first-time deposit.

  • Qualified_first_time_deposit: The number of qualified first-time deposits.

  • installs: The number of installs .

  • Active_accounts: The number of active accounts.

  • deposits_count: The count of deposits.

  • deposits:The total amount of deposits in the specified currency.

  • revenue: The total revenue in the specified currency.

  • revenue_share_commission: The revenue share commission in the specified currency.

  • last_sync: (string) The timestamp of the last synchronization (formatted as YYYY-MM-DD HH:MM:SS).

  • cpa_commission: The CPA (Cost Per Acquisition) commission in the specified currency.

  • Referral_commission: The referral commission in the specified currency.

  • total_commission: The total commission in the specified currency.

Did this answer your question?