Impression Level Revenue Server-Side API
The impression level revenue (ILR) solution provides both device level and impression level data for ironSource and your mediation ad sources. There are 2 separate APIs: 1 API for pulling device level data and 1 API for pulling impression level data. The revenue is calculated based on the eCPM of each impression, according to the app, network, country and instance.
Before you start, make sure you review our API introduction article.
How it works
- Pulling the impression level and the user level data is done in 2 steps:
- Make an API request which returns a URL link to download the report
- Download the report by clicking on the provided link
- Each API call must be made for a single app and single date.
- The data for each date is stored and available for only 14 days.
- Example: Data for January 1st will be available only until January 14th
- Each day, the data for yesterday is available starting 10:00 AM UTC. Make sure to only call the API after 10:00 AM UTC each day.
- Example: The data for January 1st is only available on January 2nd, after 10:00 AM UTC
- Each day, we update the data for yesterday and the day before yesterday. The data will not change after 2 days.
- Example: The data for January 1st will update on January 2nd and January 3rd. After January 3rd, the data will not change
- Date & App Key aren’t included in both impression and user level reports as they are unique per report (file)
Impression Level
API request for report URL
Note: A valid API hit returns a link to the requested file. The file will be available to download for one hour only.
Authentication Type
Method
GET platform.ironsrc.com/partners/adRevenueMeasurements/v4
Required Parameters
| Name | Type | Description |
| date | String | YYYY-MM-DD (UTC Timezone) |
| appKey | String | Application Key (as seen on our platform) |
Request Example URL
https://platform.ironsrc.com/partners/adRevenueMeasurements/v4?appKey=8a95a38d&date=2020-03-31
Response Example URL
{
"urls": [
"https://user-ad-revenue.s3.amazonaws.com/data/bi_databases/arm/tables/mediation/report_version%3Dv1/publisher_id%3D551399/application_id%3D225509/day%3D2020-03-31/report.csv.gz?AWSAccessKeyId=AKIAILCCGIXP5G2XNXBA&Expires=1585751272&Signature=bONL8mMc%2B0kdtekXzmXRT4shidQ%3D"
],
"expiration": "2020-03-31 14:27:52"
}Download the report
Simply click the URL to download the report
Fields Definition v3
| Field | Description | Example |
| event_timestamp | The exact date and hour of the impression in UTC | 2020-03-30 09:33:58 |
| advertising_id | Device advertising id – GAID / IDFA | fdbe7b9b-d183-4c7c-9bb5-59c9df8c35aa |
| advertising_vendor_id | Device advertising vendor id – app Set ID / IDFV | A0810F0B-16C2-474B-B765-77B3A3113AA2 |
| user_id | The user ID being set by the developer | 135920 |
| ad_unit | The ad format from which the revenue was generate from | rewarded_video |
| ad_network | The ad network name | Admob |
| instance_name | The ad network instance name as defined on the platform. For bidding sources instance name will ‘Bidding’ | High |
| country | 2 letter country code, as per ISO 3166-1 Alpha-2. | CN |
| placement | The placement the user is related to as defined on the platform | Home_Screen |
| segment | The segment the user is related to as defined based on the segmentation method. Read more | Tier 1 |
| AB_Testing | A/B testing group the user was allocated to (can be ‘A’,’B’,’N/A’) | A,B,N/A |
| revenue | The Revenue generated by the user (USD). The revenue value is either estimated (CPM /Rate) or exact (for bidder instances, excluding FAN) | 0.5 |
| mediation_ad_unit_id | ID of the ad unit which the revenue was generated from | fgx25t56dq201bd2 |
| mediation_ad_unit_name | Name of the ad unit which the revenue was generated from |
User Level
API request for report URL
Note: A valid API hit returns a link to the requested file. The file will be available to download for one hour only.
Authentication Type
Method
GET platform.ironsrc.com/partners/userAdRevenue/v3
Required Parameters
| Name | Type | Description |
| date | String | YYYY-MM-DD (UTC Timezone) |
| appKey | String | Application Key (as seen on our platform) |
| reportType | Integer | Supporting different report types. At the moment, should always set to 1 |
Request Example URL
https://platform.ironsrc.com/partners/userAdRevenue/v3?appKey=12345678&date=2018-12-15&reportType=1
Response Example URL
https://user-ad-revenue.s3.amazonaws.com/data/bi_databases/uar/tables/network/report_version%3Dv1/publisher_id%3D138101/application_id%3D100411/day%3D2018-07-13/000000.gz?AWSAccessKeyId=AKIAILCCGIXP5G2XNXBA&Expires=1532524582&Signature=1U%2FbrLmb%2F7TwXXdoHtb%2F%2FQjrmz0%3D
Download the report
Simply click the URL to download the report
Understand the report
Fields Definition
| Field | Description | Example |
| Ad Unit | The ad unit from which the revenue was generate from | rewarded_video |
| Advertising ID | The unique ID of the user’s device | 21d0e51a-772d-4b23-9fc4-296126b4f123 |
| Advertising ID Type | The unique ID type of the user’s device | IDFA/IDFV/GAID |
| User ID | The user ID being set by the developer | 135920 |
| Segment | The segment the user is related to as defined based on the segmentation method. Read more | Tier 1 |
| Placement | The placement the user is related to as defined on the platform | Home_Screen |
| Ad Network | The placement the user is related to as defined on the platform | Admob |
| A/B Testing | A/B testing group the user was allocated to (can be ‘A’ or ‘B’) | ‘A’ |
| Impressions | The number of ads displayed to the user | 1000 |
| Revenue | The Revenue generated by the user (USD). The revenue value is either estimated (CPM /Rate) or exact (for bidder instances, excluding FAN) | 0.5 |
| Mediation Ad Unit ID | ID of the ad unit which the revenue was generate from | fgx25t56dq201bd2 |
| Mediation Ad Unit Name | Name of the ad unit which the revenue was generate from |