InMobi DSP Cost API

The InMobi Cost API enables you to access the cost metrics (billable amount) for your campaigns running on the InMobi DSP. You can use the data to calculate your Return on Ad Spent (RoAS).

Pre-requisites 

Before you start the integration, make sure you have:

• An active or paused campaign on InMobi DSP. 
• Got Cost API Authentication credentials from the InMobi team. 

The API Keys and API Secret authorize access to the InMobi Cost API and generate a temporary access token. The base URL for all API requests is https://api.cdr.inmobi.com/api/v3.

Integrate Cost API

You can integrate the InMobi Cost API using the following four APIs:

• Authentication API: Generates a temporary token using the client API key for authorization. 
• Report creation API: Requests the media cost report by specifying a date range, custom dimension (or measure), and filtering on dimension (if required).
• Report status API: Check for report status. 
• Report download API: Download the report once it is available. 

Data query guidelines 

The API data query guidelines are as follows: 

Dimensions and Measures

InMobi Cost API keys have been categorized among Dimensions and Measures. 

• Dimensions refer to the keys that identify the attributes of the DSP campaigns, for example, Date, InMobi Account ID, Advertiser Name, Campaign ID, Campaign Name, Country, etc. 
• Measures refer to the campaign's metrics, for example, Impressions, Clicks, Installs, Events, Media Cost, Click-through Rate (CTR), Conversion Rate (CR), Install per mille (IPM), etc. 

API endpoints  

You must add Cost API endpoints at the end of the API Base path to initiate API calls. The Cost API offers the following endpoints: 

/programmatic & /network

Use this endpoint for Android and iOS (non-SKAN) campaigns. The dimensions and measures for /programmatic & /network are as follows:

/skan

Use this endpoint for iOS SKAN & Probabilistic Attribution campaigns. The dimensions and measures for /skan are as follows:

Call APIs

After adding the required API endpoints, you can call the Cost APIs as follows: 

Step 1: Call the Authentication API. 

The Authentication API generates a temporary token using the client API key for authorization. The token is valid for 8 hours only.  

1. Provide the token in the authorization field for subsequent calls to the API endpoint. 
2. Generate a token to call APIs. Contact your InMobi account manager to access the client ID-key pair. 

You can call the API using a POST or a cURL request 

Sample POST request  

POST URL: https://api.cdr.inmobi.com/api/v3/auth/token

Request body: 

{

clientId : string,

clientSecret : string

} 

Request field details:

Sample POST response 

{

“status”: “SUCCESS”,

“code”: 200,

“data”:

 {

 “token”:string,

 “validTill”: YYYY-MM-DDTHH:MM:SS

 },

“message”: "Request processed successfully"

} 

Response field details:

cURL Request

You can also call the Authentication API using the following cURL request:

curl --location --request POST 'https://api.cdr.inmobi.com/api/v3/auth/token' \ 
--header 'Content-Type: application/json' \ 
--data-raw '{ 
"clientId": "<YOUR-CLIENT-ID>", "clientSecret": "<YOUR-CLIENT-SECRET>" 
}' 

Step 2: Call the Report Creation API.

The Report Creation API requests the report by specifying a date range, custom attributes (dimension or measure), and filtering on dimension (if required). You can call the API using a POST or a cURL request.

Sample POST request

POST URL:

• For InMobi Network Integration:
  https://api.cdr.inmobi.com/api/v3/reports/network
• For InMobi DSP Integration (Android + iOS PA*):
  https://api.cdr.inmobi.com/api/v3/reports/programmatic
• For InMobi SKAN Integration (iOS PA + iOS SKAN):
  https://api.cdr.inmobi.com/api/v3/reports/skan

Header:

{ 
 clientId : string, 
 clientSecret : string 
} 

Body:

{ 
“startDate”: “<YYYY-MM-DD>”, 
“endDate”: “<YYYY-MM-DD>”, 
"dimensions": ["campaign_name", "country", "publisher_app_bundle"], 
"measures": ["impressions", "clicks", "installs", "media_cost"], 
"filters": 
 { 
 "os": ["Android"] 
 } 
} 

Request field details:

Sample POST response

{ 
 "status": "SUCCESS",
 "code": 200,
 "data": {
 "reportID": "<string>",
 "report_status": "available",
 "report_message": "Report available for download."
 }
 "message": "Report processed successfully"
} 

Response field details:

cURL request

curl --location --request POST 'https://api.cdr.inmobi.com/api/v3/reports/network' \
--header 'Authorization: <YOUR-AUTH-TOKEN>' \
--header 'Content-Type: application/json' \
--data-raw '{ "startDate": "<START_DATE>",
"endDate": "<END_DATE>", "dimensions": ["<DIMENSION_NAME>"], "measures": ["<MEASURE_NAME>"], "filters": 
{"<DIMENSION_NAME>": ["<DIMENSION_VALUE>", "<DIMENSION_VALUE>"]}
}'

You can also call the Report Creation API using the following cURL request:

Step 3: Call the Check Report Status API.

You can check the status of the report you called using the Report Creation API. You can call the API using a GET or cURL request.

Sample GET request

GET URL: https://api.cdr.inmobi.com/api/v3/reports//status

Header:

{
`Authorization: YOUR_TOKEN`
}

Request field details:

Sample response

{
"status": "SUCCESS",
"code": 200,
"data":
 {
 "reportStatus": "report.status.available",
 "reportStatusDescription": "Report available for download.",
 "message": "Request processed successfully"
 }
}

Response field details:

cURL

curl --location --request GET 'https://api.cdr.inmobi.com/api/v3/reports/<YOUR-REPORT-ID>/status' \
--header 'Authorization: <YOUR-AUTH-TOKEN>'

You can also call the Check Report Status API using the following cURL request:

Step 4: Call Report Download API

You can download the final CostAPI report using a GET or cURL request.

Sample GET Request

GET URL: https://api.cdr.inmobi.com/api/v3/reports//download

Header:

{
`Authorization: YOUR_TOKEN`
}

Request field details:

Sample GET Response

The CSV file of the report starts downloading on your system.

cURL Request

You can also call the Download Report API using the following cURL request:

curl --location --request GET 'https://api.cdr.inmobi.com/api/v3/reports/<YOUR-REPORT-ID>/status' \
--header 'Authorization: <YOUR-AUTH-TOKEN>'

Common API Errors

You may get the following errors during an API call. Based on the description provided, you can troubleshoot the errors.