ironSource Ads Instances API

Use this API to manage your traditional (non-bidding) instances for the ironSource Ads network on external mediations.

The API supports the following: Create, Read, Update and Delete

Requests are limited to 1 application per call.

Rate limits

The API returns a 429 HTTP status code if a request exceeds 8000 requests in a time period of 30 minutes.

Maintenance mode

If the API is under maintenance, it will return 503 HTTP status code with an error message.

Authentication Type

Bearer API authentication

Request Example URL

https://platform.ironsrc.com/ads/instances/v1/[APP_KEY]

GET

Get a list of your application’s ironSource traditional instances. 

Request Parameters

Response Parameters

Response Example 

[
  {
    	"instanceId": 0,
    	"instanceName": "Default",
    	"adUnit": "rewardedVideo",
    	"isLive": false,
    	"isOptimized": true,
    	"isInTestMode": false
  },
  {
    	"instanceId": 123456
    	"instanceName": "instance1",
    	"adUnit": "rewardedVideo",
    	"isLive": true,
    	"isOptimized": false,
      "isInTestMode": false,
    	
    	"globalPricing": 10,
    	"countriesPricing": [
	{
		"country": "US",
		"eCPM": 20
	},
	{
		"country": "CN",
		"eCPM": 20
	},	{
		"country": "AU",
		"eCPM": 30
	}
]
  }
]

CREATE

Description
Use this API to create traditional ironSource instances You can create multiple instances with a single API call.

Note:

1. This API allows you to create multiple instances with a single API call.
2. The instance Id value is reachable using Get call to this API

Request Parameters

Request Example

[
  {
    	"instanceName": "instance1",
    	"adUnit": "rewardedVideo",
    	"isLive": false
  },
  {
    	"instanceName": "instance2",
    	"adUnit": "interstitial",
    	"isLive": true,
    	"isOptimized": false,
    	"globalPricing": 10,
    	"countriesPricing": [
	{
		"country": "US",
		"eCPM": 20
	},
	{
		"country": "CN",
		"eCPM": 20
	},	{
		"country": "AU",
		"eCPM": 30
	}
]
  }
]

Success – A successful response will be sent with HTTP code 200.

UPDATE

Description

Use this API to update ironSource instances

Note:

1. Multiple instances can be updated with a single API call
2. To remove the globalPricing, simply enter null into  the field parameter To remove the countriesPricing, simply add the field parameter with empty array [] value.

Supported Parameters

Request Example

[
  {
	"instanceId": 0,
    	"adUnit": "rewardedVideo",
    	"instanceName": "instance1_update",
    	"isLive": true
  },
  {
	"instanceId": 12345
    	"instanceName": "instance2_update",
    	"adUnit": "interstitial",
    	"isLive": false,
    	"globalPricing": 100,
    	"countriesPricing": []
  }
]

Success – A successful response will be sent with HTTP code 200.

DELETE

Description

Use this API to delete ironSource instances.

Notes:

1. Multiple instances can be deleted with a single API call
2. The default instances cannot be deleted
3. Deleted instances cannot be restored

Required Parameters

Request body example

[
  {
      "instanceId": 1458
  },
  {
      "instanceId": 123654
  },
]

Success – A successful response will be sent with HTTP code 200.

Errors

If one of the instances sent in the request is failing, an error array will be sent with HTTP code 400 and will cause the whole request to be rejected.

Each error will be followed with an error message.

Example

{
    "errorsArray": [
        {
            "code": "ERR-3201",
            "errorMessage": "Instance name is required",
            "params": {
                "[0].instancename": ""
            }
        },
        {
            "code": "ERR-3328",
            "errorMessage": "countriesPricing country is invalid",
            "params": {
                "[0].countriesPricing[0].country": ""
            }
        }
    ],
    "code": 400
}