Instances API v2

Important! The Instance API v2 will sunset in October 2023. Start using Instance API v4 for improved performance, A/B test groups support, and more.

Use this API to manage instances on the ironSource dashboard.

Before you start make sure you go over our API introduction article.

Note: Instance API does not support apps during a live A/B test

Get Instances

Description
Use this API to retrieve a list of all of your application’s instances. The response will include all information from the Applications List API, as well as the following: instance name, instance ID, status, and pricing if relevant (pricing is only available for ironSource network instances)

Authentication Type

Bearer API authentication

Method
GET platform.ironsrc.com/partners/publisher/instances/v3?

Required Parameters

Name	Type	Description
appKey	String	application Key (as seen on our platform)

Request Example URL

https://platform.ironsrc.com/partners/publisher/instances/v3?appKey=aa2209b1d

Response Parameters

Name	Description
appKey	application key (as seen on our platform)
appName	the application name
appStatus	the application status
platform	platform can be iOS or android
bundleId	the native app store bundle id
creationDate	the date the app was added to ironSource platform
id	unique instance ID generated by ironSource platform on instance creation
provider instance level config*	for ad source instance level configs naming convention refer to this article
name	the instance name
status	instance status can be active or inactive
rate	instance level rate (if defined)
pricing	pricing as set on the platform for ironSource network
abVersion	A/B test version (optional values are: “A”, “B”, “N/A”)

JSON Example Response

{
  "appKey": "aa2209b1d",
  "appName": "My Test App",
  "appStatus": "active",
  "platform": "Android",
  "bundleId": "com.test.app",
  "creationDate": "N/A",
  "adUnits": {
    "rewardedVideo": {
      "activeNetworks": [
        "ironSource",
        "AdColony"
      ],
      "activeBidderNetworks": [
        ""
      ],
      "networkInstances": {
        "ironSource": [
          {
            "id": 0,
            "name": "Default",
            "status": "active",
            "pricing": [
              {
                "eCPM": "10.5",
                "Countries": [
                  "FR",
                  "UK"
                ]
              }
            ],
            "abVersion": "N/A"
          }
        ],
        "AdColony": [
          {
            "id": 0,
            "zoneId": "zone_ID_US_High",
            "name": "US_high",
            "status": "active",
            "rate": 87,
            "abVersion": "N/A"
          },
          {
            "id": 2851429,
            "zoneId": "zone_ID_US_Low",
            "name": "US_Low",
            "status": "active",
            "rate": 12,
            "abVersion": "N/A"
          }
        ]
      },
      "networkBidderInstances": []
    },
    "offerWall": {
      "activeNetworks": [
        "ironSource"
      ]
    },
    "interstitial": {
      "activeNetworks": [],
      "activeBidderNetworks": [],
      "networkInstances": {
        "ironSource": [
          {
            "id": 0,
            "name": "Default",
            "status": "inactive",
            "pricing": [
              {
                "eCPM": "8.5",
                "Countries": [
                  "FR",
                  "UK"
                ]
              }
            ],
            "abVersion": "N/A"
          }
        ]
      },
      "networkBidderInstances": []
    },
    "banner": {
      "activeNetworks": [],
      "networkInstances": {
        "ironSource": [
          {
            "id": 0,
            "name": "Default",
            "status": "inactive",
            "abVersion": "N/A"
          }
        ]
      }
    }
  }
}

Create Instances

Description
Use this API to create instances for both ironSource network and mediated ad sources. This API allows you to create multiple instances with a single API call.

Notes:

Instances created without a ‘status’ parameter set will be automatically set as ‘active’
Instances created for apps that are not live at the store will be automatically set as ‘inactive’
For Mediation users – each newly created instance will be included in all of the app’s mediation groups.
Each app is limited up to 10 instances per ad unit. In order to extend this limitation Contact Us or reach out to your Account Manager.
To create instances for mediated ad sources, please refer to this article for naming convention.
To create bidder networks Contact Us or reach out to your Account Manager.

CPM pricing:

General –

CPM Pricing allows you the control and flexibility to define expected CPM rates from ironSource’s network. Read more here.
CPM pricing is available for specific accounts only, to activate CPM pricing Contact Us or reach out to your Account Manager.
For best practices on using instances with pricing go to our Best Practices article.

Notes –

In order to set global pricing for an instance, populate the instance’s country field with asterisk character ‘*’.
Instances created without pricing and countries without defined pricing will be set to use optimized pricing.
Countries are defined based on 2 letter country code, as per ISO 3166-1 Alpha-2.

Authentication Type

Bearer API authentication

Method

POST platform.ironsrc.com/partners/publisher/instances/v3?

Required Parameters

Name	Type	Description
appKey	String	application Key (as seen on our platform)
provider	String array	for ad source naming convention refer to this article
adUnit	String array	“rewardedVideo”, “interstitial”, “banner”
instanceName	String	the newly created instance’s name
provider instance level config*	String	for ad source instance level configs naming convention refer to this article

Note: *Note: provider instance level config is only mandatory on the creation of mediation a source instances. This parameter naming varies between mediation ad sources. For naming convention go to this article.

Optional Parameters

Name	Type	Description
status	String	instance status can be ‘active’ or ‘inactive’
pricing	String array	determine the eCPM to be delivered by ironSource network
rate	Double	instance level rate (if defined)
provider app level configs*	String	for ad source app level configs naming convention refer to this article

Note: *Note: ad source app level configs varies between mediation ad sources. For naming convention go to this article.

Request Example URL

https://platform.ironsrc.com/partners/publisher/instances/v3?

Request Example Body

{
  "appKey": "d11a21a5",
  "configurations": {
    "ironSource": {
      "interstitial": [
        {
          "instanceName": "low_interstitial",
          "status": "active",
          "pricing": [
            {
              "country": [
                "FR",
                "DE"
              ],
              "eCPM": 3
            }
          ],
          "pricingType": "eCPM"
        },
        {
          "instanceName": "high_interstitial",
          "status": "active",
          "pricing": [
            {
              "country": [
                "IL",
                "US"
              ],
              "eCPM": 20
            }
          ]
        }
      ]
    },
    "adColony": {
      "rewardedVideo": [
        {
          "instanceName": "adcolony_rv",
          "status": "active",
          "zoneId": 102030,
          "rate": 10
        }
      ]
    }
  }
}

JSON Example Response

{
  "rewardedVideo": {
    "AdColony": [
      {
        "id": 6701121,
        "zoneId": "102030",
        "name": "adcolony_rv",
        "status": "active",
        "rate": 10,
        "abVersion": "N/A"
      }
    ]
  },
  "interstitial": {
    "ironSource": [
      {
        "id": 0,
        "name": "Default",
        "status": "active",
        "abVersion": "N/A"
      },
      {
        "id": 6701117,
        "name": "low_interstitial",
        "status": "active",
        "abVersion": "N/A",
        "pricing": [
          {
            "eCPM": 3,
            "Countries": [
              "FR",
              "DE"
            ]
          }
        ]
      },
      {
        "id": 6701119,
        "name": "high_interstitial",
        "status": "active",
        "abVersion": "N/A",
        "pricing": [
          {
            "eCPM": 20,
            "Countries": [
              "IL",
              "US"
            ]
          }
        ]
      }
    ],
    "ironSourceBidding": [
      {
        "id": 2948695,
        "name": "",
        "status": "inactive",
        "abVersion": "N/A"
      }
    ]
  }
}

Update Instances

Description

Use this API to update instance name, status and pricing for ironSource network and mediation ad sources (pricing is only available for ironSource network). Multiple instances can be updated with a single API call.

Notes:

Max number of update calls is limited to 6 per day.
In order to activate ironSource’s non default instances you must first activate ironSource’s default instance (instance ID=0).
Updating instance pricing will replace all pricing values on that same instance only.
To update mediation ad source instances please refer to this article for naming convention.
To update bidder networks Contact Us or reach out to your Account Manager.
To remove instance level rate simply add the rate parameter with an empty string value (eg “”)

Authentication Type

Bearer API authentication

Method

PUT platform.ironsrc.com/partners/publisher/instances/v3?

Required Parameters

Name	Type	Description
appKey	String	Application Key (as seen on our platform)
provider	String array	For ad source naming convention refer to this article
adUnit	String array	“rewardedVideo”, “interstitial”, “banner”
instanceId	String	ID generated by ironSource platform on instance creation

Optional Parameters

Name	Type	Description
name	String	the desired instance’s name
pricing	String	determine the eCPM to be delivered by ironSource network
status	String	instance status can be ‘active’ or ‘inactive’
rate	Double	instance level rate (if defined)
provider instance level config*	String	for ad source instance level configs naming convention refer to this article
provider app level config*	String	for ad source app level configs naming convention refer to this article

Note: *Note: provider app and instance level configs naming varies between mediation ad sources. For naming convention go to this article.

Request Example URL

https://platform.ironsrc.com/partners/publisher/instances/v3?

Request Body Example

{
  "appKey": "6bc83099",
  "configurations": {
    "ironSourceBidding": {
      "rewardedVideo": [
        {
          "instanceId": 327,
          "status": "inactive"
        }
      ]
    }
  }
}

JSON Response Example

{
  "rewardedVideo": {
    "ironSource": [
      {
        "id": 0,
        "name": "Default",
        "status": "inactive",
        "abVersion": "N/A"
      }
    ],
    "AdColony": [
      {
        "id": 0,
        "name": "default",
        "status": "active",
        "abVersion": "N/A"
      },
      {
        "id": 326,
        "name": "lw",
        "status": "inactive",
        "rate":"2",
        "abVersion": "N/A"
      }
    ],
    "ironSourceBidding": [
      {
        "id": 327,
        "name": "-",
        "status": "inactive",
        "abVersion": "N/A"
      }
    ]
  },
  "interstitial": {
    "ironSource": [
      {
        "id": 0,
        "name": "Default",
        "status": "active",
        "abVersion": "N/A"
      }
    ]
  },
  "banner": {
    "ironSource": [
      {
        "id": 0,
        "name": "Default",
        "status": "inactive",
        "abVersion": "N/A"
      }
    ]
  }
}

Delete Instance

Description

Use this API to delete an instance.

General notes:

Can delete one instance per call.
Default instance cannot be deleted.
Deleted instance cannot be restored.
Response includes all of the app’s instances excluding the deleted ones.

Authentication Type

Bearer API authentication

Method

DELETE platform.ironsrc.com/partners/publisher/instances/v3?

Required Parameters

Name	Type	Description
appKey	String	application Key (as seen on our platform)
instanceId	String	ID generated by ironSource platform on instance creation

Request Example URL

http://platform.ironsrc.com/partners/publisher/instances/v3?appKey=6e9e4c11&instanceId=12345

JSON Response Example

{
  "rewardedVideo": {
    "ironSource": [
      {
        "id": 0,
        "name": "Default",
        "status": "active"
      },
      {
        "id": 45678,
        "name": "thirdRVInstance",
        "status": "inactive"
      }
    ]
  },
  "interstitial": {
    "ironSource": [
      {
        "id": 0,
        "name": "Default",
        "status": "active"
      },
      {
        "id": 23456,
        "name": "secondISInstance",
        "status": "active",
        "pricing": [
          {
            "eCPM": "0.01",
            "Countries": [
              "FR",
              "UK"
            ]
          }
        ]
      }
    ]
  },
  "banner": {
    "ironSource": [
      {
        "id": 0,
        "name": "Default",
        "status": "inactive"
      }
    ]
  }
}