General Reporting API (V4)

Description

Receive all the reporting data from the monetization ad units you serve with ironSource, including multiple metrics such as revenue, impressions and activeUsers, etc. across several breakdowns and optional filters.

Authentication type

Standard authentication

Method

GET platform.ironsrc.com/partners/publisher/mediation/applications/v4/stats

Parameters

Name	Type	Description	Default	Mandatory
startDate	String	YYYY-MM-DD (UTC Timezone)	–	Yes
endDate	String	YYYY-MM-DD (UTC Timezone)	–	Yes
appKey	String	Application Key (as seen on our platform).	All App keys	No
country	String	2 letter country code, as per ISO 3166-1 Alpha-2.	All Countries	No
adUnits	String	Options are ‘rewardedVideo’, ‘offerWall’, ‘interstitial’ or ‘banner’.	All Ad Units	No
metrics	String	Metrics differ based on ad unit, see table below.	All Metrics	No
breakdowns	String	For available breakdowns – See Note below	adUnits, date	No

Supported Metrics by Ad Unit

Metric	RewardedVideo	Interstitial	Offerwall
revenue	✔	✔	✔
eCPM	✔	✔	✔
mediationFillRate	✔	✔
mediationRequests	✔	✔
impressions	✔	✔	✔
completions	✔		✔
averageRevenue	✔		✔
mediationFills	✔	✔
useRate	✔
activeUsers	✔	✔
engagedUsers	✔	✔
engagementRate	✔	✔
impressionsPerEngagedUser	✔	✔
revenuePerActiveUser	✔	✔
revenuePerEngagedUser	✔	✔
clicks	✔	✔	✔
clickThroughRate	✔	✔	✔
completionRate			✔
adSourceChecks	✔	✔
adSourceResponses	✔	✔
availabilityRate	✔	✔
sessions	✔	✔
engagedSessions	✔	✔
impressionsPerSession	✔	✔
impressionPerEngagedSessions	✔	✔
sessionsPerActiveUser	✔	✔

Request Example URL

https://platform.ironsrc.com/partners/publisher/mediation/applications/v4/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
      }
    ]
  }
]