Groups API v4

Use this API to manage mediation groups on the LevelPlay dashboard. The API supports the following:

• Managing mediation groups setup
• Managing Waterfall per mediation group

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

GET

GET

Description

Get the list of your application groups. 

Method

GET https://platform.ironsrc.com/levelPlay/groups/v4/{appKey}

Request Parameters

Request Example URL

https://platform.ironsrc.com/levelPlay/groups/v4/142401ac1/

Response Parameters

Response Example 

[code-snippet lang="jsonp"]

[
  {
    "groupId": 12673,
    "groupName": "newGroup",
    "mediationAdUnitId": "fgx25t56dq201bd2",
    "mediationAdUnitName": "interstitial-1",
    "adFormat": "interstitial",
    "abTest": "A",
    "countries": ["FR","US"],
    "position": 1,
    "segments": [],
    "floorPrice": 0.3,
    "instances": [
      {
        "id": 3681,
        "name": "",
        "networkName": "ironSource",
        "isBidder": true
      },
      {
        "id": 2,
        "name": "Default",
        "isBidder": false,
        "networkName": "unityAds",
        "groupRate": 5,
        "countriesRate": [
          {
            "countryCode": "FR",
            "rate": 1
          }
        ]
      }
    ]
  }
]

[/code-snippet]

CREATE

CREATE

Use this API to create mediation groups. This API allows you to create multiple groups with a single API call. Use the “instances” parameter to determine each instance to include/exclude in a group. The instance ID value is reachable using the Instances API.

• This API allows you to create multiple groups with a single API call.
• The Group Id value is reachable using Get call to this API
• The instance ID value is reachable using the Instances API.

Method

POST https://platform.ironsrc.com/levelPlay/groups/v4/{appKey}

Request Parameters

Request Example URL

https://platform.ironsrc.com/levelPlay/groups/v4/142401ac1/

Supported Parameters

Request Example 

[code-snippet lang="jsonp"]

[
  {
    "groupName": "new group",
    "adFormat": "rewarded",
    "mediationAdUnitId": "fgx25t56dq201bd2",
    "countries": ["FR","US"],
    "position": 1,
    "segments": ["nonPaying"],
    "abTest": "B",
    "floorPrice": 0.3,
    "instances": [
      {
        "id": 7983541,
        "groupRate": 2,
        "countriesRate": [
          {
            "countryCode": "FR",
            "rate": 1
          }
        ]
      },
      {
        "id": 4896357
      },
      {
        "id": 62624583,
        "countriesRate": [
          {
            "countryCode": "US",
            "rate": 5.3
          }
        ]
      }
    ]
  }
]

[/code-snippet]

UPDATE

UPDATE

Use this API to update mediation groups setup configuration and waterfalls

• Multiple groups can be updated with a single API call
• To remove the groupRate/countryRate, add the field parameter with null value.
• To update an array field, include all values (new and existing).

Method

PUT https://platform.ironsrc.com/levelPlay/groups/v4/{appKey}

Request Parameters

Request Example URL

https://platform.ironsrc.com/levelPlay/groups/v4/142401ac1/

Supported Parameters

Request Example

[code-snippet lang="jsonp"]

[
  {
    "groupId": 123,
    "groupName": "new group",
    "countries": ["FR","US"],
    "position": 1,
    "segments": [],
    "floorPrice": 0.3,
    "instances": [
      {
        "id": 1,
        "groupRate": null,
        "countriesRate": [
          {
            "countryCode": "FR",
            "rate": 1
          }
        ]
      },
      {
        "id": 2,
        "countriesRate": [
          {
            "countryCode": "FR",
            "rate": 1.4
          }
        ]
      }
    ]
  }
]

[/code-snippet]

Success

A successful response will be sent with HTTP code 200.

DELETE

DELETE

Use this API to delete an instance.

• The AllCountries group cannot be deleted.
• Deleted groups cannot be restored.

Method

DELETE https://platform.ironsrc.com/levelPlay/groups/v4/{appKey}

Request Parameters

Request Example URL

https://platform.ironsrc.com/levelPlay/groups/v4/142401ac1/

Supported Parameters

Request body example

[code-snippet lang="jsonp"]

{
    "ids": [1458, 5769]
}

[/code-snippet]

Success

Success

A successful response will be sent with HTTP code 200.

Errors

Errors

If one of the groups 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

[code-snippet lang="jsonp"]

{
    "errorsArray": [
        {
            "code": ERR-208,
            "errorMessage": "Group name value is required",
            "params": {
                "[0].groupName": ""
            }
        },
        {
            "code": ERR-311,
            "errorMessage": "Group position value is not valid",
            "params": {
                "[0].position": ""
            }
        }
    ],
    "code": 400
}

[/code-snippet]