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.

 NoteOur Reporting API is limited to 20 requests every 10 minutes.

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.
  • secret key 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:
    1
  • PHP code example for generating username:secret key:
     <?php
    $crl = curl_init();
    $base64encoded = base64_encode("[username]:[secret key]");
    $header = array();
    $header[] = 'Authorization: Basic '. $base64encoded;
     $URL='https://platform.ironsrc.com/partners/publisher/mediation/applications/<latest version>/stats;
     curl_setopt($crl, CURLOPT_URL, $URL);
    curl_setopt($crl, CURLOPT_HTTPHEADER, $header);
     $response = curl_exec($crl);
     curl_close($crl);
     ?>

General Reporting API (V5)

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/v5/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
metrics String For available metrics – See Note below All Metrics
breakdowns String For available breakdowns – See Note below adUnits, date

Notes:

  1. Check out all of our available metrics 
  2. Check out all of our available breakdowns
  3. All our parameters support multiple comma separated values

Example Request & Response


Request URL

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

JSON 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 for Apps List (V3)

Description 

Get a list of applications that are using monetization Ad Units. The list you will get in the response will include all your apps, it’s status, Ad Units and mediated ad networks.

Method

GET platform.ironsrc.com/partners/publisher/applications/v3

Parameters

None

Request Example URL

GET https://platform.ironsrc.com/partners/publisher/applications/v3?

JSON Response

{
  "appKey": "5db456bd",
  "appName": "App Name",
  "platform": "Android",
  "bundleId": "com.appName",
  "creationDate": "2017-01-24",
  "appStatus": "active",
  "adUnits": {
    "rewardedVideo": {
      "ironSourceNetworkStatus": "active",
      "activeNetworks": [
        "Vungle",
        "TapJoy",
        "AppLovin",
        "ironSourceBackfill",
        "CrossPromotion"
      ]
    },
    "offerWall": {
      "ironSourceNetworkStatus": "inactive",
      "activeNetworks": []
    },
    "interstitial": {
      "ironSourceNetworkStatus": "inactive",
      "activeNetworks": []
    },
    "banner": {
      "ironSourceNetworkStatus": "inactive",
      "activeNetworks": []
    }
  },
  "network_reporting_api": {
    "ironSource": "verified",
    "Vungle": "verified",
    "TapJoy": "verified",
    "AppLovin": "verified",
    "ironSourceBackfill": "verified",
    "CrossPromotion": "verified"
  }
}

Parameters

Name Description
appKey Application Key (as seen on our platform)
application_name The application name
platform IOS or Android
bundle_id The native app store bundle_id
CreationDate The date the app was added to ironSource platform
adUnits Includes the active ad networks’ names per ad unit
network_reporting_api Includes the active ad networks’ reporting API status

Appendices

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

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

API for Apps List (V2)

Description 

Get a list of applications that are using monetization Ad Units. The list you will get in the response will include all your apps.

Method

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

Parameters

None

Request Example URL

GET https://platform.ironsrc.com/partners/publisher/applications/v2?

JSON Response

Name Type Description
appKey String
Application Key (as seen on our platform).
application_name String
The application name
platform String IOS or Android
bundle_id String
The native app store bundle_id