Instances API v4

Use the Instance API to manage instances on the LevelPlay dashboard. This API version supports the following:

• Support for CRUD
• Changing ad networks’ application-level configurations
• Adding or removing instances from waterfall groups (Supporting active AB test applications)

Requests are limited to 1 application per call.

Rate limits

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

Authentication Type

Bearer API authentication

Request Example URL

https://platform.ironsrc.com/levelPlay/network/instances/v4/[APP_KEY]

GET 

Get a list of all the application instances, bidding and non bidding. 

Request Parameters

Response Parameters

Response Example 

[ 
    {
        "instanceId": 1072562,
        "instanceName": "Default",
        "adUnit": "rewardedVideo",
        "networkName": "adColony",
        "appConfig1": "qtr",
        "instanceConfig1": "trb",
        "isBidder": true,
        "groups": [
            101663
        ],
        "isLive": true,
	 "rate": 10
    },
    {
        "instanceId": 1014428,
        "instanceName": "Default",
        "adUnit": "interstitial",
        "networkName": "unity",
        "appConfig1": "qertb",
        "instanceConfig1": "qtrb",
        "isBidder": false,
        "groups": [
            101663
        ],
        "isLive": true,
	 "rate": 25
    },
    {
        "instanceId": 1845809,
        "instanceName": "Default",
        "adUnit": "rewardedVideo",
        "networkName": "adManager",
        "appConfig1": "bqw",
        "instanceConfig1": "qqr",
        "isBidder": false,
        "groups": [
            101663
        ],
        "isLive": true,
        "rate": 4
    }
]

CREATE 

Description
Use this API to create instances for mediated ad sources. This API allows you to create multiple instances with a single API call. Keep in mind that when creating instances via the API, you are limited to the number of instances the platform allows.

Use the “groups” parameter to determine each waterfall group to include/exclude instance. The “groups” ID value is reachable using the Mediation API.

Note:

1. Instances created without a ‘status’ parameter set will be automatically set as ‘active’
2. Instances created for apps that are not live at the store will be automatically set as ‘inactive’
3. To create instances for mediated ad networks, refer to this article for naming convention.
4. Application configuration must have the same value for instances with the same ad network

Request Parameters

Request Example 

[
  {
      "instanceName": "newInstance",      
      "networkName": "adColony",
      "adUnit": "rewardedVideo",
      "isBidder": true,
      "appConfig1": "414n",
      "instanceConfig1": "aaa1",
      "instanceConfig2": "aaa1",
      "groups": [12345],
      "isLive": true,
      "rate": 2
  }
]

UPDATE

Description

Use this API to update instances. Multiple instances can be updated with a single API call.

Note:

To remove instance level rate, simply add the rate parameter with ‘null’  value. 

Supported Parameters

Request Example

[
  {
      "instanceId": 122,
      "instanceName": "newInstance",
      "appConfig1": "414n",
      "instanceConfig1": "aaa1",
      "instanceConfig2": "aaa1",
      "groups": [1],
      "isLive": true,
      "rate": 2
  }
]

DELETE

Description

Use this API to delete an instance.

Notes:

1. Default instances cannot be deleted.
2. Deleted instances cannot be restored.

Required Parameters

Request body example

[
  {
      "instanceId": 58
  },
  {
      "instanceId": 59
  },
]

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.

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 void. Each error has a code which is explained in the table below.

Example:

API v3 (previous version)

Note: Instance API v3 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

Request Example URL

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

Response Parameters

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:

1. Instances created without a ‘status’ parameter set will be automatically set as ‘active’
2. Instances created for apps that are not live at the store will be automatically set as ‘inactive’
3. For Mediation users – each newly created instance will be included in all of the app’s mediation groups.
4. 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.
5. To create instances for mediated ad sources, please refer to this article for naming convention.
6. To create bidder networks Contact Us or reach out to your Account Manager.

CPM pricing:

Authentication Type

Bearer API authentication

Method

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

Required Parameters

Optional Parameters

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:

1. Max number of update calls is limited to 6 per day.
2. In order to activate ironSource’s non default instances you must first activate ironSource’s default instance (instance ID=0).
3. Updating instance pricing will replace all pricing values on that same instance only.
4. To update mediation ad source instances please refer to this article for naming convention.
5. To update bidder networks Contact Us or reach out to your Account Manager.
6. 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

Optional Parameters

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:

1. Can delete one instance per call.
2. Default instance cannot be deleted.
3. Deleted instance cannot be restored.
4. 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

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"
      }
    ]
  }
}