Mediation Management

Use this API to get all the groups and waterfalls you have set on ironSource’s dashboard.

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

Get Mediation Groups

Description
Use this API to retrieve a list of all of your application’s groups and its matching waterfalls setup. The response will include the following: group name, group ID, group segment, group countries, group position and group waterfall.

Authentication Type

Bearer API authentication

Method

GET https://platform.ironsrc.com/partners/publisher/mediation/management/v1?

Required Parameters

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

Request Example URL

https://platform.ironsrc.com/partners/publisher/mediation/management/v1?appKey=813df9s5

Response Parameters

Name Description
appName the application name
appStatus app status can be active or inactive
platform iOS or Android
bundleId the native app store bundle_id
adUnits includes the active ad networks names per ad unit
groupName mediation group’s name as defined on the platform
groupId mediation group’s ID
groupPosition mediation group’s position in ironSource platform
groupSegments mediation group’s segments (optional)
groupCountries mediation group’s countries
adSourcePriority mediation group’s waterfall setup
providerName provider name (e.g Facebook, ironSource)
instanceName the instance name as defined on the platform 
instanceId unique ID generated by ironSource platform on instance creation

JSON Example Response

{
  "appKey": "813df9s5",
  "appName": "My App",
  "appStatus": "active",
  "platform": "iOS",
  "bundleId": "com.my.app",
  "adUnits": {
    "banner": [
      {
        "groupName": "US",
        "groupId": 185919,
        "groupPosition": 1,
        "groupSegments": [],
        "groupCountries": [
          "US"
        ],
        "adSourcePriority": {
          "auto": [
            {
              "providerName": "Facebook",
              "instanceName": "Banner_HighCPM",
              "instanceId": 1054777
            },
            {
              "providerName": "Facebook",
              "instanceName": "Banner_AnyPrice",
              "instanceId": 0
            },
            {
              "providerName": "AppLovin",
              "instanceName": "Default",
              "instanceId": 0
            }
          ]
        }
      },
      {
        "groupName": "All Countries",
        "groupId": 119625,
        "groupPosition": 2,
        "groupSegments": [],
        "groupCountries": [
          "*"
        ],
        "adSourcePriority": {
          "manualHigh": [
            {
              "providerName": "Facebook",
              "instanceName": "Banner_HighCPM",
              "instanceId": 1054777
            }
          ],
          "auto": [
            {
              "providerName": "AppLovin",
              "instanceName": "Default",
              "instanceId": 0
            },
            {
              "providerName": "Facebook",
              "instanceName": "Banner_AnyPrice",
              "instanceId": 0
            }
          ]
        },
        "isAllCountries": true
      }
    ],
    "interstitial": [
      {
        "groupName": "US",
        "groupId": 185917,
        "groupPosition": 1,
        "groupSegments": [],
        "groupCountries": [
          "US"
        ],
        "adSourcePriority": {
          "manualHigh": [
            {
              "providerName": "ironSource",
              "instanceName": "Default",
              "instanceId": 0
            }
          ],
          "auto": [
            {
              "providerName": "Facebook",
              "instanceName": "FB_Interstitial_HighCPM",
              "instanceId": 1054773
            },
            {
              "providerName": "Facebook",
              "instanceName": "FB_Interstitial_AnyPrice",
              "instanceId": 0
            }
          ]
        }
      },
      {
        "groupName": "All Countries",
        "groupId": 119627,
        "groupPosition": 2,
        "groupSegments": [],
        "groupCountries": [
          "*"
        ],
        "adSourcePriority": {
          "auto": [
            {
              "providerName": "Facebook",
              "instanceName": "FB_Interstitial_HighCPM",
              "instanceId": 1054773
            },
            {
              "providerName": "Facebook",
              "instanceName": "FB_Interstitial_AnyPrice",
              "instanceId": 0
            },
            {
              "providerName": "ironSource",
              "instanceName": "Default",
              "instanceId": 0
            }
          ]
        },
        "isAllCountries": true
      }
    ],
    "rewardedVideo": [
      {
        "groupName": "United States Ad Whales",
        "groupId": 2617,
        "groupPosition": 1,
        "groupSegments": [
          {
            "id": "3205",
            "name": "US Ad Whales"
          }
        ],
        "groupCountries": [
          "US"
        ],
        "adSourcePriority": {
          "manualHigh": [
            {
              "providerName": "ironSource",
              "instanceName": "Default",
              "instanceId": 0
            },
            {
              "providerName": "AppLovin",
              "instanceName": "Default",
              "instanceId": 0
            },
            {
              "providerName": "Facebook",
              "instanceName": "FB_RV_HighCPM",
              "instanceId": 0
            }
          ],
          "auto": [
            {
              "providerName": "Facebook",
              "instanceName": "FB_RV_AnyPrice",
              "instanceId": 1054769
            },
            {
              "providerName": "UnityAds",
              "instanceName": "Default",
              "instanceId": 0
            }
          ]
        }
      },
      {
        "groupName": "US",
        "groupId": 185913,
        "groupPosition": 2,
        "groupSegments": [],
        "groupCountries": [
          "US"
        ],
        "adSourcePriority": {
          "auto": [
            {
              "providerName": "Facebook",
              "instanceName": "FB_RV_AnyPrice",
              "instanceId": 1054769
            },
            {
              "providerName": "Facebook",
              "instanceName": "FB_RV_HighCPM",
              "instanceId": 0
            },
            {
              "providerName": "AppLovin",
              "instanceName": "Default",
              "instanceId": 0
            },
            {
              "providerName": "UnityAds",
              "instanceName": "Default",
              "instanceId": 0
            },
            {
              "providerName": "ironSource",
              "instanceName": "Default",
              "instanceId": 0
            }
          ]
        }
      },
      {
        "groupName": "Turkey",
        "groupId": 2613,
        "groupPosition": 3,
        "groupSegments": [],
        "groupCountries": [
          "TR"
        ],
        "adSourcePriority": {
          "manualHigh": [
            {
              "providerName": "Facebook",
              "instanceName": "FB_RV_HighCPM",
              "instanceId": 0
            }
          ],
          "auto": [
            {
              "providerName": "Facebook",
              "instanceName": "FB_RV_AnyPrice",
              "instanceId": 1054769
            },
            {
              "providerName": "ironSource",
              "instanceName": "Default",
              "instanceId": 0
            },
            {
              "providerName": "AppLovin",
              "instanceName": "Default",
              "instanceId": 0
            },
            {
              "providerName": "UnityAds",
              "instanceName": "Default",
              "instanceId": 0
            }
          ]
        }
      },
      {
        "groupName": "Tier 1",
        "groupId": 2577,
        "groupPosition": 4,
        "groupSegments": [],
        "groupCountries": [
          "AU",
          "CN",
          "DE",
          "GB"
        ],
        "adSourcePriority": {
          "manualHigh": [
            {
              "providerName": "AppLovin",
              "instanceName": "Default",
              "instanceId": 0
            }
          ],
          "auto": [
            {
              "providerName": "Facebook",
              "instanceName": "FB_RV_HighCPM",
              "instanceId": 0
            },
            {
              "providerName": "ironSource",
              "instanceName": "Default",
              "instanceId": 0
            },
            {
              "providerName": "UnityAds",
              "instanceName": "Default",
              "instanceId": 0
            },
            {
              "providerName": "Facebook",
              "instanceName": "FB_RV_AnyPrice",
              "instanceId": 1054769
            }
          ]
        }
      },
      {
        "groupName": "All Countries",
        "groupId": 2557,
        "groupPosition": 5,
        "groupSegments": [],
        "groupCountries": [
          "*"
        ],
        "adSourcePriority": {
          "auto": [
            {
              "providerName": "Facebook",
              "instanceName": "FB_RV_AnyPrice",
              "instanceId": 1054769
            },
            {
              "providerName": "Facebook",
              "instanceName": "FB_RV_HighCPM",
              "instanceId": 0
            },
            {
              "providerName": "AppLovin",
              "instanceName": "Default",
              "instanceId": 0
            },
            {
              "providerName": "UnityAds",
              "instanceName": "Default",
              "instanceId": 0
            },
            {
              "providerName": "ironSource",
              "instanceName": "Default",
              "instanceId": 0
            }
          ]
        },
        "isAllCountries": true
      }
    ]
  }
}