raise support ticket
BACK

Additional Reading

API Details

Manage Apps

  1. Get the list of apps 

    • Request URL: https://publisher.inmobi.com/rest/api/v2/apps
    • Request method: GET 
    • Request parameters (query): 
      Name  Description  Required  Type  Sample/Available values 
      pageNum   page number  Optional  Integer  1, 2, 3 etc. 
      pageLength   number of records per page  Optional  Integer

      1, 2, 3 etc. 

      Default number of results: 10 
      status   status of the app  Optional  String 

      Available values : ACTIVE, DRAFT, ARCHIVE, FLAGGED 

      Default value: ACTIVE 
    • Request body: NA
    • Response format
      • Response body: 
        { 
  "success": true, 
  "data": { 
    "totalRecords": 281, 
    "records": [ 
      { 
        "storeUrl": "string", 
        "appName": "string", 
        "platform": "string", 
        "bundleId": "string", 
        "childDirected": 1, 
        "appRating": "string", 
        "appId": 0 
      } 
    ] 
  } 
}
      • Response body values:
        Name  Description  Type  Sample/Possible values 
        Success Determines success of the response Boolean

        true – request successful

        false – request unsuccessful with some error(s)
        storeUrl App store/Play store URL of the app String (url) URL
        appName Name of the app String Sample App
        Platform Platform of the app String Android or iPhone (iOS)
        bundleId Bundle of the apps as registered in the store String Com.org.app
        childDirected Determines the audience type of the app Integer

        1 – App is not directed towards children

        2 – App is directed towards children and requires parental consent

        3 – App is directed partially towards children and towards adults
        appRating Content Rating of the app String  
        appId ID of the app on InMobi dashboard Numeric  

  2. Get the details of a specific app

    • Request URL: https://publisher.inmobi.com/rest/api/v2/apps/{appId} (App ID should be mentioned in the request URL)
    • Request method: GET
    • Request parameters (query): NA
    • Request body: NA
    • Response format
      • Response body: 
        
{ 
  "success": true, 
  "data": { 
    "storeUrl": "string", 
    "appName": "string", 
    "platform": "string", 
    "bundleId": "string", 
    "childDirected": 0, 
    "appRating": "string", 
    "appId": 0 
  }, 
  "status": "string", 
  "createdOn": "string" 
}
      • Response body values:
        Name  Description  Type  Sample/Possible values 
        Success Determines success of the response Boolean

        true – request successful

         

        false – request unsuccessful with some error(s)
        storeUrl App store/Play store URL of the app String (url) URL
        appName Name of the app String Sample App
        Platform Platform of the app String Android or iOS
        bundleId Bundle of the apps as registered in the store String Com.org.app
        childDirected Determines the audience type of the app Integer

        1 – App is not directed towards children

        2 – App is directed towards children and requires parental consent

        3 – App is directed partially towards children and towards adults
        appRating Content Rating of the app String  
        appId ID of the app on InMobi dashboard Numeric  
        status Current status of the app on platform String PENDING REVIEW, ACTIVE, FLAGGED, REJECTED, ARCHIVED
        createdOn Date of app creation on platform String  

  3. Create a new app

    • Request URL: https://publisher.inmobi.com/rest/api/v2/apps
    • Request method: POST
    • Request parameters (query): NA
    • Request body:
      • Schema: 
        { 
  "storeUrl": "string", 
  "childDirected": 0, 
  "locationAccess": true, 
  "appName": "string" 
}
      • Request body values:
        Name  Description  Required  Type  Sample/Possible values 
        storeUrl App store/Play store URL of the app Required String (url) URL
        locationAccess Specify if InMobi can access the location details Required Boolean

        true – InMobi will be able to use the location data collected by this app.

        false – InMobi will not be able to access the location data collected by this app.
        childDirected Specify the audience type of the app Required Integer

        1 – App is not directed towards children

        2 – App is directed towards children and requires parental consent

        3 – App is directed partially towards children and towards adults
        appName Name of the app Optional String Sample App
      • Response format:
        • Response body: 
          { 
  "success": true, 
  "data": { 
    "storeUrl": "string", 
    "appName": "string", 
    "platform": "string", 
    "bundleId": "string", 
    "childDirected": 0, 
    "appRating": "string", 
    "appId": 0 
  }, 
  "status": "string", 
  "createdOn": "string" 
}
        • Response parameters:
          Name  Description  Type  Sample/Possible values 
          Success Determines success of the response Boolean true – request successful
          storeUrl App store/Play store URL of the app String (url) URL
          appName Name of the app String Sample App
          Platform Platform of the app String Android or iOS
          bundleId Bundle of the apps as registered in the store String Com.bundle.app
          childDirected Determines the audience type of the app Integer

          1 – App is not directed towards children

          2 – App is directed towards children and requires parental consent

          3 – App is directed partially towards children and towards adults
          appRating Content Rating of the app String  
          appId ID of the app on InMobi dashboard Numeric  
          status Current status of the app on platform String PENDING REVIEW, ACTIVE, FLAGGED, REJECTED, ARCHIVED
          createdOn Date of app creation on platform String  

  4. Update an existing app

    • Request URL: https://publisher.inmobi.com/rest/api/v2/apps/{appId} (App ID should be mentioned in the request URL)
    • Request method: PATCH
    • Request parameters (query): NA
    • Request body:
      • Schema: 
        { 

  "childDirected": 0, 

  "locationAccess": true, 

  "appName": "string" 

}
      • Request body values:
        Name  Description  Required  Type  Sample/Possible values 
        locationAccess Specify if InMobi can access the location details Required Boolean

        true – InMobi will be able to use the location data collected by this app.

        false – InMobi will not be able to access the location data collected by this app.
        childDirected Specify the audience type of the app Required Integer

        1 – App is not directed towards children

        2 – App is directed towards children and requires parental consent

        3 – App is directed partially towards children and towards adults
        appName Name of the app Optional String Sample App
      • Response format:
        • Response body: 
          { 
  "success": true, 
  "data": { 
    "storeUrl": "string", 
    "appName": "string", 
    "platform": "string", 
    "bundleId": "string", 
    "childDirected": 0, 
    "appRating": "string", 
    "appId": 0 
  }, 
  "status": "string", 
  "createdOn": "string" 
}
        • Response parameters:
          Name  Description  Type  Sample/Possible values 
          Success Determines success of the response Boolean true – request successful
          storeUrl App store/Play store URL of the app String (url) URL
          appName Name of the app String Sample App
          Platform Platform of the app String Android or iOS
          bundleId Bundle of the apps as registered in the store String Com.bundle.app
          childDirected Determines the audience type of the app Integer

          1 – App is not directed towards children

          2 – App is directed towards children and requires parental consent

          3 – App is directed partially towards children and towards adults
          appRating Content Rating of the app String  
          appId ID of the app on InMobi dashboard Numeric  
          status Current status of the app on platform String PENDING REVIEW, ACTIVE, FLAGGED, REJECTED, ARCHIVED
          createdOn Date of app creation on platform Optional   

Manage Placements

  1. Get the list of placements in an app 

    • Request URL: https://publisher.inmobi.com/rest/api/v1/placements 
    • Request method: GET 
    • Request parameters (query): 
      Name  Description  Required  Type  Sample/Available values 
      pageNum   page number  Optional  Integer  1, 2, 3 etc. 
      pageLength   number of records per page  Optional  Integer

      1, 2, 3 etc. 

      Default number of results: 10 
      appId    The ID of an app   Required   Integer  

       
      placementType  The type of placement  Optional  String  Available values : INTERSTITIAL, BANNER, REWARDED_VIDEO, NATIVE 
    • Request body: NA
    • Response format
      • Response body: 
        { 
  "success": true, 
  "data": { 
    "totalRecords": 281, 
    "records": [ 
      { 
        "storeUrl": "string", 
        "appName": "string", 
        "platform": "string", 
        "bundleId": "string", 
        "childDirected": true, 
        "appRating": "string", 
        "appId": 0 
      }, 
      { 
        "placementId": 0, 
        "placementName": "string", 
        "placementType": "string", 
        "testMode": "string", 
        "status": "string", 
        "appId": 0, 
        "cpmFloor": 0, 
        "isAudienceBiddingEnabled": true, 
        "audienceBiddingPartner": "string", 
        "a9TagId": "string", 
        "a9AppId": "string", 
        "isFallbackPlacement": true, 
        "createdOn": "string" 
      } 
    ] 
  } 
}
      • Response parameters:
        Name  Description  Type  Sample/Possible values 
        Success Determines success of the response Boolean

        true – request successful

        false – request unsuccessful with some error(s)
        storeUrl App store/Play store URL of the app String (url) URL
        appName Name of the app String  
        Platform Platform of the app String Android or iPhone (iOS)
        bundleId Bundle of the apps as registered in the store String Com.org.app
        childDirected Determines the audience type of the app Integer

        1 – App is not directed towards children

        2 – App is directed towards children and requires parental consent

        3 – App is directed partially towards children and towards adults
        appRating Content Rating of the app String  
        appId App key on InMobi platform  Integer   
        placementId  ID of the placement as on InMobi platform  Integer   
        placementName  Placement name as on InMobi platform  String   
        placementType  Type of placement  String  Available values : INTERSTITIAL, BANNER, REWARDED_VIDEO, NATIVE 
        testMode  Test mode of the placement  String 

        On – Test mode is on for specific devices as mentioned in the integration testing in InMobi platform 

        Global – Test mode is on for all devices with this app 

        Off – Test mode is off for all devices with this app 
        status  Current status of the placement  String  Available values : ACTIVE, DRAFT, ARCHIVE, FLAGGED 
        cpmFloor  eCPM floor set on the InMobi platform  Number   
        isAudienceBiddingEnabled  Determines if Audience Bidding is enabled for this placement  Boolean 

        true – Audience Bidding is on 

        false – Audience Bidding is off 

         audienceBiddingPartner 

        		 Audience Bidding Partner (applicable only if Audience Bidding is enabled)  String  Available values: MAX, AMAZON_TAM, GOOGLE_OPEN_BIDDING, CUSTOM_MEDIATION, IRONSOURCE, SPRINGSERVE, PREBID, FYBER, ADMOST, AEQUUS, GAMEANALYTICS_HYPERBID, MESON, CHARTBOOST, GOOGLE_SDK_BIDDING 
        a9TagId  Tag ID (applicable only in case of Amazon TAM as Audience Bidding partner)  String   
        A9AppId App ID (applicable only in case of Amazon TAM as Audience Bidding partner)  String   
        createdOn  Creation date of the placement  String   

  2. Get the details of a specific placement in an app

    • Request URL: https://publisher.inmobi.com/rest/api/v1/placements/{placementId} (Placement ID should be mentioned in the request URL)
    • Request method: GET
    • Request parameters (query): NA
    • Request body: NA
    • Response format
      • Response body: 
        { 

  "success": true, 

  "data": { 

    "placementId": 0, 

    "placementName": "string", 

    "placementType": "string", 

    "testMode": "string", 

    "status": "string", 

    "appId": 0, 

    "cpmFloor": 0, 

    "isAudienceBiddingEnabled": true, 

    "audienceBiddingPartner": "string", 

    "a9TagId": "string", 

    "a9AppId": "string", 

    "isFallbackPlacement": true, 

    "createdOn": "string" 

  } 

}
      • Response parameters:
        Name  Description  Type  Sample/Possible values 
        Success Determines success of the response Boolean

        true – request successful

        false – request unsuccessful with some error(s)
        appId App key on InMobi platform  Integer   
        placementId  ID of the placement as on InMobi platform  Integer   
        placementName  Placement name as on InMobi platform  String   
        placementType  Type of placement  String  Available values : INTERSTITIAL, BANNER, REWARDED_VIDEO, NATIVE 
        testMode  Test mode of the placement  String 

        On – Test mode is on for specific devices as mentioned in the integration testing in InMobi platform 

        Global – Test mode is on for all devices with this app 

        Off – Test mode is off for all devices with this app 
        status  Current status of the placement  String  Available values : ACTIVE, DRAFT, ARCHIVE, FLAGGED 
        cpmFloor  eCPM floor set on the InMobi platform  Number   
        isAudienceBiddingEnabled  Determines if Audience Bidding is enabled for this placement  Boolean 

        true – Audience Bidding is on 

        false – Audience Bidding is off 

         audienceBiddingPartner 

        		 Audience Bidding Partner (applicable only if Audience Bidding is enabled)  String  Available values: MAX, AMAZON_TAM, GOOGLE_OPEN_BIDDING, CUSTOM_MEDIATION, IRONSOURCE, SPRINGSERVE, PREBID, FYBER, ADMOST, AEQUUS, GAMEANALYTICS_HYPERBID, MESON, CHARTBOOST, GOOGLE_SDK_BIDDING 
        a9TagId  Tag ID (applicable only in case of Amazon TAM as Audience Bidding partner)  String   
        A9AppId App ID (applicable only in case of Amazon TAM as Audience Bidding partner)  String   
        createdOn  Creation date of the placement  String   

  3. Create a new placement in an app

    • Request URL: https://publisher.inmobi.com/rest/api/v1/placements
    • Request method: POST
    • Request parameters (query): NA
    • Request body:
      • Schema: 
        { 

  "appId": 0, 

  "placementName": "string", 

  "placementType": "INTERSTITIAL", 

  "cpmFloor": 0, 

  "isAudienceBiddingEnabled": true, 

  "audienceBiddingPartner": "string", 

  "a9TagId": "string", 

  "a9AppId": "string", 

  "isFallbackPlacement": true 

}
      • Request body values:
        Name  Description  Required  Type  Sample/Possible values 
        appId App key on InMobi platform Required Integer  
        placementName Placement name as on InMobi platform Required String  
        placementType Type of placement Required String Available values : INTERSTITIAL, BANNER, REWARDED_VIDEO, NATIVE
        cpmFloor eCPM floor set on the InMobi platform Optional (not appicable in case isAudienceBiddingEnabled is "true") Number  
        isAudienceBiddingEnabled Determines if Audience Bidding is enabled for this placement Required Boolean true – Audience Bidding is on false – Audience Bidding is off
        audienceBiddingPartner Audience Bidding Partner (applicable only if Audience Bidding is enabled) Required (only if isAudienceBiddingEnabled is “true”) String Available values: MOPUB, MAX, AMAZON_TAM, GOOGLE_OPEN_BIDDING, CUSTOM_MEDIATION, IRONSOURCE, SPRINGSERVE, PREBID, FYBER, ADMOST, AEQUUS, GAMEANALYTICS_HYPERBID, MESON, CHARTBOOST, GOOGLE_SDK_BIDDING
        a9TagId Tag ID of Amazon TAM placement Required (only in case of Amazon TAM as Audience Bidding partner) String  
        A9AppId App ID of Amazon TAM placement Required (only in case of Amazon TAM as Audience Bidding partner) String  
      • Response format:
        • Response body schema: 
          { 
  "success": true, 
  "data": { 
    "placementId": 0, 
    "placementName": "string", 
    "placementType": "string", 
    "testMode": "string", 
    "status": "string", 
    "appId": 0, 
    "cpmFloor": 0, 
    "isAudienceBiddingEnabled": true, 
    "audienceBiddingPartner": "string", 
    "a9TagId": "string", 
    "a9AppId": "string", 
    "isFallbackPlacement": true, 
    "createdOn": "string" 
  } 
}
        • Response values:
          Name  Description  Type  Sample/Possible values 
          Success Determines success of the response Boolean

          true – request successful 

          false – request unsuccessful with some error(s) 
          placementId  ID of the placement as on InMobi platform  Integer   
          placementName  Placement name as on InMobi platform  String  
          placementType  Type of placement  String Available values : INTERSTITIAL, BANNER, REWARDED_VIDEO, NATIVE 
          testMode  Test mode of the placement  String ON – Test mode is on for specific devices as mentioned in the integration testing in InMobi platform 

          GLOBAL – Test mode is on for all devices with this app 

          OFF – Test mode is off for all devices with this app
          cpmFloor  eCPM floor set on the InMobi platform  Number 

           
          isAudienceBiddingEnabled  Determines if Audience Bidding is enabled for this placement  Boolean 

          true – Audience Bidding is on 

          false – Audience Bidding is off 
          audienceBiddingPartner  Audience Bidding Partner (applicable only if Audience Bidding is enabled)  String 

          Available values: MOPUB, MAX, AMAZON_TAM, GOOGLE_OPEN_BIDDING, CUSTOM_MEDIATION, IRONSOURCE, SPRINGSERVE, PREBID, FYBER, ADMOST, AEQUUS,  GAMEANALYTICS_HYPERBID, MESON, CHARTBOOST, GOOGLE_SDK_BIDDING 
          appId App key on InMobi platform  Integer  
          a9TagId  Tag ID (applicable only in case of Amazon TAM as Audience Bidding partner)  String   
          A9AppId  App ID (applicable only in case of Amazon TAM as Audience Bidding partner)  String   
          status Current status of the placement  String Available values : ACTIVE, DRAFT, ARCHIVE, FLAGGED 
          createdOn Creation date of the placement  String  

  4. Update an existing placement in an app

    • Request URL: https://publisher.inmobi.com/rest/api/v1/placements/{placementId} (Placement ID should be mentioned in the request URL)
    • Request method: PATCH
    • Request parameters (query): NA
    • Request body:
      • Schema: 
        { 

  "placementName": "string", 

  "cpmFloor": 0, 

  "isAudienceBiddingEnabled": true, 

  "audienceBiddingPartner": "string", 

  "a9TagId": "string", 

  "a9AppId": "string", 

}
      • Request body values:
        Name  Description  Required  Type  Sample/Possible values 
        placementName Placement name as on InMobi platform Required String  
        cpmFloor eCPM floor set on the InMobi platform Optional (not appicable in case isAudienceBiddingEnabled is "true") Number  
        isAudienceBiddingEnabled Determines if Audience Bidding is enabled for this placement Optional Boolean true – Audience Bidding is on false – Audience Bidding is off
        audienceBiddingPartner Audience Bidding Partner (applicable only if Audience Bidding is enabled) Required (only if isAudienceBiddingEnabled is “true”) String Available values: MOPUB, MAX, AMAZON_TAM, GOOGLE_OPEN_BIDDING, CUSTOM_MEDIATION, IRONSOURCE, SPRINGSERVE, PREBID, FYBER, ADMOST, AEQUUS, GAMEANALYTICS_HYPERBID, MESON, CHARTBOOST, GOOGLE_SDK_BIDDING
        a9TagId Tag ID of Amazon TAM placement Required (only in case of Amazon TAM as Audience Bidding partner) String  
        A9AppId App ID of Amazon TAM placement Required (only in case of Amazon TAM as Audience Bidding partner) String  
      • Response format:
        • Response body: 
          { 
  "success": true, 
  "data": { 
    "placementId": 0, 
    "placementName": "string", 
    "placementType": "string", 
    "testMode": "string", 
    "status": "string", 
    "appId": 0, 
    "cpmFloor": 0, 
    "isAudienceBiddingEnabled": true, 
    "audienceBiddingPartner": "string", 
    "a9TagId": "string", 
    "a9AppId": "string", 
    "isFallbackPlacement": true, 
    "createdOn": "string" 
  } 
}
        • Response body values:
          Name  Description  Type  Sample/Possible values 
          Success Determines success of the response Boolean

          true – request successful 

          false – request unsuccessful with some error(s) 
          placementId  ID of the placement as on InMobi platform  Integer   
          placementName  Placement name as on InMobi platform  String  
          placementType  Type of placement  String Available values : INTERSTITIAL, BANNER, REWARDED_VIDEO, NATIVE 
          testMode  Test mode of the placement  String ON – Test mode is on for specific devices as mentioned in the integration testing in InMobi platform 

          GLOBAL – Test mode is on for all devices with this app 

          OFF – Test mode is off for all devices with this app
          cpmFloor  eCPM floor set on the InMobi platform  Number 

           
          isAudienceBiddingEnabled  Determines if Audience Bidding is enabled for this placement  Boolean 

          true – Audience Bidding is on 

          false – Audience Bidding is off 
          audienceBiddingPartner  Audience Bidding Partner (applicable only if Audience Bidding is enabled)  String 

          Available values: MOPUB, MAX, AMAZON_TAM, GOOGLE_OPEN_BIDDING, CUSTOM_MEDIATION, IRONSOURCE, SPRINGSERVE, PREBID, FYBER, ADMOST, AEQUUS, GAMEANALYTICS_HYPERBID, MESON, CHARTBOOST, GOOGLE_SDK_BIDDING 
          appId App key on InMobi platform  Integer  
          a9TagId  Tag ID (applicable only in case of Amazon TAM as Audience Bidding partner)  String   
          A9AppId  App ID (applicable only in case of Amazon TAM as Audience Bidding partner)  String   
          status Current status of the placement  String Available values : ACTIVE, DRAFT, ARCHIVE, FLAGGED 
          createdOn Creation date of the placement  String  

Possible errors 

Following are the possible error scenarios that might arise while using these APIs:

Error code  Type  Description 
400  Bad request response  Please check the values passed in the request body for correct values in correct formats
401  Unauthorized request response  Please check the values passed in the header and auth for correct values 
500  Internal server error response  There is an internal issue. Please try again after some time or contact InMobi CSM or support (email us at [email protected]) 

 Rate limits 

The rate of requests for each publisher is capped to 500 requests in an interval of 15 minutes. 

In case of any unresolved queries, please reach out to your CSM or reach out to us at [email protected]. You can also raise a ticket here: https://support.inmobi.com/mytickets. 

On This Page

Last Updated on: 22 Oct, 2024
✕

You are almost there...

By installing this SDK update, you agree that your Children Privacy Compliance setting remains accurate or that you will update that setting, whenever there is a change in your app's audience. You may update the app's Children Privacy Compliance settings at https://publisher.inmobi.com/my-inventory/app-and-placements.

I AGREE