Monetization Reporting API

In this article you’ll learn how to use the ironSource Reporting API in order to retrieve statistics about your monetization activity.

Get Your Authentication

First, you’ll need to add an authorization header for authentication.

Authentication is based on Basic HTTP Authentication with HTTPS. The HTTP Authorization header is created based on the base64 version of username:secret key.

username is the login/email that is used to login to our system.

The secret key parameter is unique for your ironSource account. To retrieve it, click on your user profile on the top right corner of the screen, and select ‘My Account’. You will find the secret key in the Reporting API section:

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.Method
GET platform.ironsrc.com/partners/publisher/mediation/applications/v4/stats

Supported Metrics by Ad Unit

Effective cost per thousand impressions. eCPM is average revenue you receive for every thousand ad impressions. eCPM is calculated as (Total Earnings / Impressions) x 1000.

appFillRate

✔

✔

The number of times an ad was shown to users compared to the number of times an was requested from a specific ad source. The fillrate for each ad source is calculated as Impressions / Mediation Requests. If you choose to break down by ad source, this metric will not return in the response.

appRequests

✔

✔

Number of times your app requested an ad from the mediation layer. The amount of requests may differ based on filtering. If you choose to break down by ad source, this metric will not return in the response.

impressions

✔

✔

✔

An ad impression is recorded whenever an ad is displayed in your app.

completions

✔

✔

For Rewarded Video: the amount of video completions.
For Offerwall: the amount of completed offers.

revenuePerCompletion

✔

✔

The ratio of revenue generated in cents per completion, calculated as revenue / completions.

appFills

✔

✔

The number of ad requests that generated a positive response. If you choose to break down by ad source, this metric will not return in the response.

useRate

✔

The ratio between impressions and fulfillments, calculated as impression events / total fulfillments

activeUsers

✔

✔

Indicates the amount of daily active users (DAU); i.e. the average number of unique users who initiated an app session during a defined timeframe

engagedUsers

✔

✔

The average of active users who engaged with an ad in your app; data is drawn from impression events

engagedUsersRate

✔

✔

The ratio between engaged users and active users; calculated as engaged users / total active users

impressionsPerEngagedUser

✔

✔

Portrays how many impressions were seen by engaged users; calculated as total impression events / total engaged users

revenuePerActiveUser

✔

✔

Indicates the average revenue per active user (ARPU) in cents; calculated as total revenue/ total active users

revenuePerEngagedUser

✔

✔

Indicates the revenue earned per engaged user in cents; calculated as total revenue / total engaged users

clicks

✔

✔

The total number of times users clicked on ads served on your app

clickThroughRate

✔

✔

The ratio between impressions and clicks; calculated as clicks / impressions

completionRate

✔

Indicates the amount of users to complete a defined action

adSourceChecks

✔

✔

The amount of times an ad source is asked whether it is ready to show an ad

adSourceResponse

✔

✔

The number of times an ad source had an ad available to show at the time of the request

adSourceAvailabilityRate

✔

✔

The rate at which an ad source had an ad available when an ad was requested, calculated Impressions/ Ad Source Requests

sessions

✔

✔

The sum of single periods of user interaction with your app (each SDK init generates a new session)

engagedSessions

✔

✔

The sum of sessions in which a user interacts with an ad

impressionsPerSession

✔

✔

The average amount of ads served throughout a single session, calculated as Impressions/Session

impressionsPerEngagedSessions

✔

✔

The average amount of ad impressions during an engaged session, calculated as Impressions/Engaged Sessions

sessionsPerActiveUser

✔

✔

The average number of sessions generated by an active user on a daily basis, calculated as Sessions/Active User

Appendices

General Reporting API (V3)

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.Method
GET platform.ironsrc.com/partners/publisher/mediation/applications/v3/stats

Supported Metrics by Ad Unit

Effective cost per thousand impressions. eCPM is average revenue you receive for every thousand ad impressions. eCPM is calculated as (Total Earnings / Impressions) x 1000.

mediationFillRate

✔

✔

The number of times an ad was shown to users compared to the number of times an was requested from a specific ad source. The fillrate for each ad source is calculated as Impressions / Mediation Requests. If you choose to break down by ad source, this metric will not return in the response.

mediationRequests

✔

✔

Number of times your app requested an ad from the mediation layer. The amount of requests may differ based on filtering. If you choose to break down by ad source, this metric will not return in the response.

impressions

✔

✔

✔

An ad impression is recorded whenever an ad is displayed in your app.

completions

✔

✔

For Rewarded Video: the amount of video completions.
For Offerwall: the amount of completed offers.

averageRevenue

✔

✔

The ratio of revenue generated in cents per completion, calculated as revenue / completions.

mediationFills

✔

✔

The number of ad requests that generated a positive response. If you choose to break down by ad source, this metric will not return in the response.

useRate

✔

The ratio between impressions and fulfillments, calculated as impression events / total fulfillments

activeUsers

✔

✔

Indicates the amount of daily active users (DAU); i.e. the average number of unique users who initiated an app session during a defined timeframe

engagedUsers

✔

✔

The average of active users who engaged with an ad in your app; data is drawn from impression events

engagedUsersRate

✔

✔

The ratio between engaged users and active users; calculated as engaged users / total active users

impressionsPerEngagedUser

✔

✔

Portrays how many impressions were seen by engaged users; calculated as total impression events / total engaged users

revenuePerActiveUser

✔

✔

Indicates the average revenue per active user (ARPU) in cents; calculated as total revenue/ total active users

revenuePerEngagedUser

✔

✔

Indicates the revenue earned per engaged user in cents; calculated as total revenue / total engaged users

clicks

✔

✔

The total number of times users clicked on ads served on your app

clickThroughRate

✔

✔

The ratio between impressions and clicks; calculated as clicks / impressions

completionRate

✔

Indicates the amount of users to complete a defined action

adSourceChecks

✔

✔

The amount of times an ad source is asked whether it is ready to show an ad

adSourceResponse

✔

✔

The number of times an ad source had an ad available to show at the time of the request

availabilityRate

✔

✔

The rate at which an ad source had an ad available when an ad was requested, calculated Impressions/ Ad Source Requests

sessions

✔

✔

The sum of single periods of user interaction with your app (each SDK init generates a new session)

engagedSessions

✔

✔

The sum of sessions in which a user interacts with an ad

impressionsPerSession

✔

✔

The average amount of ads served throughout a single session, calculated as Impressions/Session

impressionsPerEngagedSessions

✔

✔

The average amount of ad impressions during an engaged session, calculated as Impressions/Engaged Sessions

sessionsPerActiveUser

✔

✔

The average number of sessions generated by an active user on a daily basis, calculated as Sessions/Active User

General Reporting API (V2)

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.

Method

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

Effective cost per thousand impressions. eCPM is average revenue you receive for every thousand ad impressions. eCPM is calculated as (Total Earnings / Impressions) x 1000.

fillRate

✔

✔

The number of times an ad was shown to users compared to the number of times an ad was requested from the mediation layer. The fillrate for each ad source is calculated as Impressions / Mediation Requests.

requests

✔

✔

Number of times your app requested an ad from the mediation layer. The amount of requests may differ based on filtering.

impressions

✔

✔

✔

An ad impression is recorded whenever an ad is displayed in your app.

completions

✔

✔

For Rewarded Video: the amount of video completions.
For Offerwall: the amount of completed offers.

averageRevenue

✔

✔

The ratio of revenue generated in cents per completion, calculated as revenue / completions.

fulfillments

✔

✔

The number of ad requests that generated a positive response.

impressionPerFulfillmentRate

✔

The ratio between impressions and fulfillments, calculated as impression events / total fulfillments

activeUsers

✔

✔

Indicates the amount of daily active users (DAU); i.e. the average number of unique users who initiated an app session during a defined timeframe

engagedUsers

✔

✔

The average of active users who engaged with an ad in your app; data is drawn from impression events

engagedUsersRate

✔

✔

The ratio between engaged users and active users; calculated as engaged users / total active users

impressionsPerEngagedUser

✔

✔

Portrays how many impressions were seen by engaged users; calculated as total impression events / total engaged users

revenuePerActiveUser

✔

✔

Indicates the average revenue per active user (ARPU) in cents; calculated as total revenue/ total active users

revenuePerEngagedUser

✔

✔

Indicates the revenue earned per engaged user in cents; calculated as total revenue / total engaged users

clicks

✔

✔

The total number of times users clicked on ads served on your app

clickRate

✔

✔

The ratio between impressions and clicks; calculated as clicks / impressions

“full” means that the information collected for the date interval is complete, i.e. if we scrape at a later date this information will be the same. “partial” could be used to indicate that the your network has not finished aggregating the data.

app_id

String

Your app ID

application_name

String

The application name

platform

Enum

Would contain: apple_itunes / google_play

bundle_id

String

The native app store bundle_id. This can either be the Google Play package name or the Apple App id

“full” means that the information collected for the date interval is complete, i.e. if we scrape at a later date this information will be the same. “partial” could be used to indicate that the your network has not finished aggregating the data

¹ If the expense is 4 USD, the number sent will be 4 * 100 = 400. Do the same for other currencies, even if there is no subunit corresponding to the US cent. E.g., if the expense is 50 JPY, the number sent should be 50 * 100 = 5000.

¹ If the expense is 4 USD, the number sent will be 4 * 100 = 400. Do the same for other currencies, even if there is no subunit corresponding to the US cent. E.g., if the expense is 50 JPY, the number sent should be 50 * 100 = 5000.