Contact usContact us

Reporting API

Use this API to receive all the reporting data from the monetization ad units you serve with ironSource, including multiple metrics such as revenue, impressions and active users, etc. across several breakdowns and optional filters.

Before you start make sure you go over our API introduction article.

Note: Our Reporting API is limited to 40 requests every 10 minutes.

Authentication type

Bearer API authentication

Method

GET  platform.ironsrc.com/partners/publisher/mediation/applications/v6/stats?

Required Parameters

Name Type Description Default
startDate String YYYY-MM-DD (UTC Timezone) –
endDate String YYYY-MM-DD (UTC Timezone) –

Optional Parameters

With the ironSource reporting API, reports can be filtered by any one of the optional parameters. Doing so searches for a direct match to any of the filters.

Name Type Description Default
appKey String Application Key (as seen on our platform) All App keys
country String 2 letter country code, as per ISO 3166-1 Alpha-2. All Countries
adUnits String Options are ‘rewardedVideo’, ‘offerWall’, ‘interstitial’ or ‘banner’ All Ad Units
adSource String Mediated ad networks, Including ironSource All Ad Sources
isLevelPlayMediation String Relevant only for ironSource network, options are ‘true’ or ‘false’, supported as of March 1st, 2024
mediationGroup String Mediation Group (as seen on our platform) All Groups
mediationAdUnitId String ID of the ad unit which the revenue was generated from All Mediation Ad Units
metrics String For available metrics – See below All Metrics
breakdowns String For available breakdowns – See below adUnits, date


Supported Breakdowns

  1. date
  2. app
  3. platform
  4. adSource
  5. adUnits
  6. instance
  7. country
  8. mediationGroup
  9. mediationAdUnitId
  10. segment
  11. placement
  12. osVersion
  13. connectionType
  14. sdkVersion
  15. appVersion
  16. att
  17. idfa
  18. abTest
  19. isLevelPlayMediation (supported as of March 1st, 2024)

Check out all of our supported breakdowns by metric 

Supported Metrics

Check out all of our available metrics 

Note: All our parameters support multiple comma separated values.

Request Example URL

https://platform.ironsrc.com/partners/publisher/mediation/applications/v6/stats?startDate=2018-08-01&endDate=2018-08-01&appKey=6fa4475&adSource=ironSource&metrics=revenue,impressions,eCPM&breakdown=adUnits

JSON Example Response

[
  {
    "adUnits": "Rewarded Video",
    "date": "2018-08-01",
    "data": [
      {
        "revenue": 71188.8,
        "impressions": 13321624,
        "eCPM": 5.34
      }
    ]
  },
  {
    "adUnits": "Interstitial",
    "date": "2018-08-01",
    "data": [
      {
        "revenue": 39437.81,
        "impressions": 6077264,
        "eCPM": 6.49
      }
    ]
  },
  {
    "adUnits": "Offerwall",
    "date": "2018-08-01",
    "data": [
      {
        "revenue": 43.78,
        "impressions": 14873,
        "eCPM": 2.94
      }
    ]
  }
]

API Versions