Application API

Use this API to get and create applications on ironSource’s dashboard.

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

Get Apps

Description

Use this API to retrieve a list of all of your apps. The response will include the detailed parameters as described in the table above

Authentication Type

Bearer API authentication

Method

GET platform.ironsrc.com/partners/publisher/applications/v6?

Required Parameters
None

Request Example URL
https://platform.ironsrc.com/partners/publisher/applications/v6?

Response Parameters

Name Description
appKey application Key (as seen on our platform)
appName the application name
appStatus app status can be active or inactive
platform iOS or Android
bundleId the store bundle id
trackId the application store track id (iOS only)
taxonomy the application sub-genre. for the list of all available sub-genres refer to this article
creationDate the date the application was added to ironSource platform
icon the application icon (fetch from the store)
adUnits includes the active ad networks names per ad unit
networkReportingApi includes the active ad network’s reporting API status
coppa The COPPA settings of the application (true=1/false=0)
ccpa the CCPA settings of the application (true=1/false=0)

JSON Example Response

 [
    {
        "appKey": "6be7c3bd",
        "appName": "puzzl2999",
        "appStatus": "active",
        "platform": "Android",
        "bundleId": "unknown",
        "taxonomy": "Bingo",
        "creationDate": "01/01/2020",
        "icon": "https://local.supersonicads.com/ssastatic/partners/assets/images/appDefaultIcon.v3.png",
        "adUnits": {
            "rewardedVideo": {
                "activeNetworks": [
                    "ironSource"
                ]
            },
            "offerWall": {
                "activeNetworks": [
                    "ironSource"
                ]
            },
            "interstitial": {
                "activeNetworks": [
                    "ironSource"
                ]
            },
            "banner": {
                "activeNetworks": [
                    "ironSource"
                ]
            }
        },
        "networkReportingApi": {
            "ironSource": "verified"
        },
        "bundleRefId": 0,
        "coppa": 1,
        "ccpa": 1
    },
    {
        "appKey": "6be7e081",
        "appName": "puzzl2999666",
        "appStatus": "active",
        "platform": "Android",
        "bundleId": "unknown",
        "taxonomy": "Bingo",
        "creationDate": "01/01/2020",
        "icon": "https://local.supersonicads.com/ssastatic/partners/assets/images/appDefaultIcon.v3.png",
        "adUnits": {
            "rewardedVideo": {
                "activeNetworks": [
                    "ironSource"
                ]
            },
            "offerWall": {
                "activeNetworks": [
                    "ironSource"
                ]
            },
            "interstitial": {
                "activeNetworks": [
                    "ironSource"
                ]
            },
            "banner": {
                "activeNetworks": [
                    "ironSource"
                ]
            }
        },
        "networkReportingApi": {
            "ironSource": "verified"
        },
        "bundleRefId": 0,
        "coppa": 1,
        "ccpa": 0
    }
]

Create App

Description
Use this API to create an app on ironSource platform. When creating an app using the app creation API we automatically create each one of the supported ad units (Rewarded Video, Interstitial, Banner, Offerwall) on ‘Off’ status – unless requested otherwise.

Authentication Type

Bearer API authentication

Method

POST platform.ironsrc.com/partners/publisher/applications/v6?

Required Parameters (for creation of a live app)

Name Type Description
storeUrl String the store URL of the app
taxonomy String the application sub-genre. for the list of all available sub-genres refer to this article
coppa Integer the coppa status of the application (true = 1 / false = 0)

Required Parameters (for creation of an app that is not live in the store)

Name Type Description
appName String the application name
platform String iOS or Android
coppa Integer
the coppa status of the application (true = 1 / false = 0)

Optional Parameters

Name Type Description
adUnit:status String “RewardedVideo”: “Live” 
ccpa Integer
the the ccpa status of the application (true = 1 / false = 0)


Request Example URL

https://platform.ironsrc.com/partners/publisher/applications/v6?

Request Example Body (creation of a live application)

{
  "storeUrl": "https://apps.apple.com/us/app/time-gap-hidden-objects/id661173158",
  "taxonomy": "puzzle",
  "appName": "puzzleApp",
  "coppa":1,
  "ccpa":0,
  "adUnits": {
    "RewardedVideo": "Live",
    "Interstitial": "Live",
    "OfferWall": "Off",
    "Banner": "Live"
  }
}

Request Example Body (creation of an app that is not live in the store)

{
 "appName": "MyTestAppiOS",
 "platform": "iOS"
}

API Versions