Custom Adapters Reporting API

The custom adapters reporting API allows ironSource mediation to retrieve your network’s revenue data, so publishers can see it in their ironSource monetization reports. We highly recommended enabling this functionality to give publishers visibility into the value of your network. Follow these steps to start using it.

Before you start

  • Make sure you complete the network registration form and include the server address for your dedicated endpoint.
  • Reporting API domain should be based on this structure  ‘https://[custom network domain]’ (Ex. https://api.exmaple.io)

Note: If you’ve submitted the form before, contact us to add your endpoint.

Reporting requests

ironSource will send requests to your endpoint a few times a day, with each call for a specific account and date.

Example request

GET  https://www.CustomNetworkEndPoint.com?date=2021-09-01&apiKey=value1&myUser=value2

Response

Structure your response like this, so ironSource can process it:

  • Date (based on the request)
  • Data array, broken down by country and instance identifier(s)

Important notes
  • Format the country field with the 2-letter country code according to ISO 3166-1 alpha-2
  • Report revenue in USD
  • Use the UTC timezone for date aggregation
  • Use unique instance identifiers since app level and ad unit (ad format) level breakdowns are not supported

    Example response

    {
    	"date": "2021-12-01",
    	"data": [{
    			"instanceKey": "1233",
    			"revenue": 0.3,
    			"country": "US"
    		},
    		{
    			"instanceKey": "2522",
    			"revenue": 0.4,
    			"country": "CN"
    		},
    		{
    			"instanceKey": "2523",
    			"revenue": 0.4,
    			"country": "AU"
    		},
    		{
    			"instanceKey": "2524",
    			"revenue": 0.4,
    			"country": "FR"
    		},
    		{
    			"instanceKey": "2525",
    			"revenue": 0.4,
    			"country": "JP"
    		}
    	]
    }