Analysis Reports

Our Analysis Reports provide more granular data that will help you make decisions to improve your campaign performance. Add as many breakdowns, metrics, and filters as you’d like for your chosen timeframe to get the desired results.

Step 1. Navigate to Promote Reports

To view the Analysis Reports go to Promote → Reports → Analysis

image-2019-01-14-at-2-18-45-am

Select the desired date range, and use the gear icon to select your date granularity, breakdowns, filters, and metrics. You will find more granular breakdowns and filters than in the Overview Reports page.
image-2019-01-13-at-1-58-49-am
These are the available granularities:

  • Day
  • Week
  • Month
  • None

These are the available Breakdowns:

  • Title
  • OS
  • Campaign ID
  • Campaign Name
  • Creative id*
  • Creative name*
  • Country
  • Application id
  • Application Name
  • Device Type
  • Ad Unit

*Note that you will only be able to view creative data for CPI campaigns that have been set up in the platform.

Step 3: Define Your Metrics

Select as many metrics as you’d like to help you perform detailed analysis of your campaigns. Choose between a number of basic, calculated, and cohort metrics. The available metrics are:

Basic metrics:

  1. Impressions: Total number of times the ad is shown.
  2. Clicks: Total number of times users clicked on the ad.
  3. Completions: Total number of times users completed the desired action of the campaign. For example, the completion for CPI campaigns is the install, and the completion for CPE campaigns is the event completion.
  4. Installs: Total number of new app installs received (the user must download and open the app).
  5. Spend: Total campaign spend.

Calculated metrics:

  1. CTR (Click Through Rate): Clicks divided by impressions.
  2. CVR (Conversion Rate): Completions divided by clicks.
  3. IPM: The number of completions generated per one thousand impressions. This is the combination of CTR & CVR, and represents the overall creative effectiveness and users desire to install your app. Calculation: Installs/Impressions*1000
  4. eCPM: The spend per one thousand impressions. This represents the marketability of your campaign within the ironSource network. Calculation: Spend/Impressions*1000
  5. eCPI (Effective Cost Per Install): Spend divided by installs. This represents the average CPI for the measured timeframe.
  6. eCPA (Effective Cost Per Action): Spend divided by completions. This represents the average CPA for the measured timeframe.

Cohort metrics:

  1. Ad revenue: The amount of revenue generated from users viewing ads in your app.
  2. IAP revenue: The amount of revenue generated from users making purchases in your app.
  3. Total revenue: The sum of Ad revenue and IAP revenue.
  4. ARPU: The average revenue generated per user within the defined cohort range. Calculation: Total Revenue from Day 0 through Day X divided by installs on Day 0.
  5. ROAS (Return On Ad Spend): The percentage of total revenue generated within the defined cohort range out of total campaign spend. Calculation: Total revenue from Day 0 through Day X divided by the total spend on day 0.
  6. Unique Purchasers: Installed users who have also completed an in-app purchase within the defined cohort range.
  7. Purchasers rate: The percentage of new users who have made an in-app purchase within the defined cohort range. Calculation: Unique Purchases from Day 0 – Day X divided by installs on Day 0.
  8. Retention: The percentage of users that return to your app on a specific day after their first app launch within the defined cohort range. Calculation: Retained users on day X divided by the number of new installs on day 0.

Cohort: Defines the time span in which to analyze users based on when they installed your app and triggered an app launch. D0 is considered the first day the user opened the app. You will thus be able to track user activity and how users develop over time from the day they installed your app within this timeframe. We currently support the following cohort ages – D1, D3, D7, D14, D30.

Once you are finished configuring the metrics and choosing a date range, select ‘Run Report’ and your report will be generated accordingly.

image-2019-01-13-at-2-03-37-am

Step 4: Export Your Data

image-2019-01-13-at-2-05-52-am

Once the report is generated, click on ‘Export Report’ if you’d like to save it or perform further analysis with the data.

Overview Reports

Our Overview Reports allow you to view high level trends to help you understand the performance of your User Acquisition campaigns. Slice and dice your data with various breakdowns, metrics, filters, and timeframes.

Step 1. Navigate to Promote Reports

To view the Reporting Overview go to Promote → Reports → Overview

image-2019-01-07-at-1-16-10-am

Step 2: Configure Your Report

Breakdowns and Filters

Break and filter your data to find specific results and separate the data to simplify your report.
The available breakdowns and filters are:

  • Title
  • Campaign
  • Country
  • Ad Unit
  • OS
  • Device Type

overviewscreenshot

Step 3: Define Your Metrics

Toggle between different metrics to see a dedicated graph for that metric. Choose between a number of basic, calculated, and cohort metrics.
The available metrics are:

Basic metrics

  1. Impressions: Total number of times the ad is shown.
  2. Clicks: Total number of times users clicked on the ad.
  3. Completions: Total number of times users completed the desired action of the campaign. For example, the completion for CPI campaigns is the install, and the completion for CPE campaigns is the event completion.
  4. Installs: Total number of new app installs received (the user must download and open the app).
  5. Spend: Total campaign spend.

Calculated metrics

  1. CTR (Click Through Rate): Clicks divided by impressions.
  2. CVR (Conversion Rate): Completions divided by clicks.
  3. IPM: The number of completions generated per one thousand impressions. This is the combination of CTR & CVR, and represents the overall creative effectiveness and users desire to install your app. Calculation: Installs/Impressions*1000
  4. eCPM: The spend per one thousand impressions. This represents the marketability of your campaign within the ironSource network. Calculation: Spend/Impressions*1000
  5. eCPI (Effective Cost Per Install): Spend divided by installs. This represents the average CPI for the measured timeframe.
  6. eCPA (Effective Cost Per Action): Spend divided by completions. This represents the average CPA for the measured timeframe.

Cohort metrics

  1. Ad revenue: The amount of revenue generated from users viewing ads in your app.
  2. IAP revenue: The amount of revenue generated from users making purchases in your app.
  3. Total revenue: The sum of Ad revenue and IAP revenue.
  4. ARPU: The average revenue generated per user within the defined cohort range. Calculation: Total Revenue from Day 0 through Day X divided by installs on Day 0.
  5. ROAS (Return On Ad Spend): The percentage of total revenue generated within the defined cohort range out of total campaign spend. Calculation: Total revenue from Day 0 through Day X divided by the total spend on Day 0.
  6. Unique Purchasers: Installed users who have also completed an in-app purchase within the defined cohort range.
  7. Purchasers rate: The percentage of new users who have made an in-app purchase within the defined cohort range. Calculation: Unique Purchases from Day 0 – Day X divided by installs on Day 0.
  8. Retention: The percentage of users that return to your app on a specific day after their first app launch within the defined cohort range. Calculation: Retained users on day X divided by the number of new installs on day 0.

Cohort: Defines the time span in which to analyze users based on when they installed your app and triggered an app launch. D0 is considered the first day the user opened the app. You will thus be able to track user activity and how users develop over time from the day they installed your app within this timeframe. We currently support the following cohort ages – D1, D3, D7, D14, D30.

URL Validations (Omer)

Error
Invalid URL/  Couldn’t fetch store data
Unique store URL (no duplications within the publisher’a account)

Status Validations (Omer)

Error
Missing company details
In order to go live contact your account manager
Cannot activate an ironSource instance when the ironSource ad unit is not active

User Ad Revenue

Description

Use this API to get your user level ad revenue report with ironSource and your mediated ad networks. The response will include the following breakdowns: user ID, Device ID, ad unit, Ad Network, Segment and Placement.

Notes:

  • Pulling user level statistics is done by these 2 steps:
    • API request for report URL, returns with a link to download the report
    • Download the report from the provided link
  • The revenue is calculated based on each user impression eCPM according to the App, Day, network, country, instance.
  • Each API call is per app per day and data is stored and available until 14 days backwards
  • The data for yesterday is available starting today 14:00 PM UTC
  • While yesterday’s data is updated we also refresh the data for the day before yesterday
  • To get the full list of all your applications that are using monetization ad units via API go to this Article 

API request for report URL

Note:  Note: A valid API hit returns a link to the requested file, the file will be available for download for one hour only. 

Authentication Type

Standard authentication

Method

GET  platform.ironsrc.com/partners/userAdRevenue

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?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 call the URL in order to fetch the report

Understand the report

Note: The report is generated without columns titles.

The columns titles and order is as followed:

  • Ad Unit
  • Advertising ID
  • Advertising ID Type
  • User ID
  • Segment
  • Placement
  • Ad Network
  • Impressions
  • Revenue

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 on the platform 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
Impressions The number of ads displayed to the user 1000
Revenue The Revenue generated by the user (USD) 0.5

* Date & App Key aren’t included as they are unique per report (file)

Pricing Validations (omer)

Error
Min Value > 0 USD
Max Value < 100 USD
In order to activate ironSource’s pricing contact your account manager
Cannot set pricing for the same country twice
Cannot set Global pricing (*) and pricing per country on the same instance 

Authentication

All ironSource API endpoints are secured, and must be used with an authentication token.
First, you’ll need to add an authorization header for authentication.

Standard API Authentication

ironSource standard authentication is used for our Reporting API and for our User Ad Revenue API.

Description

This type of 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.
  • secret key parameter is unique for your ironSource account.

You can find your Secret Key under ‘My Account‘:

1

Request Headers Example 

Basic UG9wY2FwOjI3MGYwODRirrxNmM0YTliNmUyMmFkMjRkOTA1ZGYz

AUTH API Authentication

AUTH API authentication is needed for the use of ironSource’s Application API and Instance API.

Description

AUTH API authentication is based on auth 2.0 Bearer authentication. The HTTP Authorization header is created based on your account’s unique Secret key & Refresh Token.
You can find your unique parameters under ‘My Account‘:

1

Method

GET platform.ironsrc.com/partners/publisher/auth

Request URL  

https://platform.ironsrc.com/partners/publisher/auth

Request Example Headers  

secretkey: e83defbasdasd9227a9d2a952b2c5ec8b02e
refreshToken: 5525553sdfcb87c4cab7eba082858d21a

Response Example

eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzZWNyZXRLZXkiOiJlODNkZWZiNjQ5MjI3YTlkMmE5NTJiMmM1ZWM4YjAyZSIsInJlZnJlc2hUb2tlbiI6IjU1MjU1NTNkN2NiODdjNGNhYjdlYmEwODI4NThkMjFhIiwiZXhwaXJhdGlvblRpbWUiOjE1NDY0Mzc2Mjd9.mqtDslsA1E_MnFvyiMrBCz3DgUhEQaSUChVd_Ajvvf8

The generated token should be used for the bearer token authorization:

GET https://platform.ironsrc.com/partners/publisher/instances/v1?appKey=123abc
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzZWNyZXRLZXkiOiJlODNkZWZiNjQ5MjI3YTlkMmE5NTJiMmM1ZWM4YjAyZSIsInJlZnJlc2hUb2tlbiI6IjU1MjU1NTNkN2NiODdjNGNhYjdlYmEwODI4NThkMjFhIiwiZXhwaXJhdGlvblRpbWUiOjE1NDY0Mzc2Mjd9.mqtDslsA1E_MnFvyiMrBCz3DgUhEQaSUChVd_Ajvvf8

Note:  Note: The token is valid for 60 minutes.

Name Validations (omer)

Error Code
IronSource instance name 32 characters limit
Duplicate Instance Name
Invalid characters: ‘,”,<,>,;