This metadata API returns a list of audience segments available for targeting. These segments can be used to define behavioral, contextual, or 3rd-party targeting in a deal. The API supports search, pagination, and country filtering.
Support Center
GET https://apis.demand.ssp.inmobi.com/v1/meta/audiences
| Field Name | Type | Is mandatory (Y/N)? | Description |
|---|---|---|---|
| Authorization | String | Y | Bearer token for authentication (Bearer <token>) |
| X-USER-ID | String | Y | The ID of the user making the request |
| X-INMOBI-ORG-ID | String | Y | The organization ID associated with the user |
Content-Type |
String | Y | Specifies the media type of the request body. Use: application/json |
| Field Name | Type | Is mandatory (Y/N)? | Description |
|---|---|---|---|
| limit | Integer | N | Number of segments to return per page |
| offset | Integer | N | Offset from the first result (used for pagination) |
| searchValue | String | N | Filter segments by keyword (e.g., Weather) |
| country | String | N | Filter segments by country name (e.g., USA) |
curl -X GET "https://apis.demand.ssp.inmobi.com/v1/meta/audiences?limit=2&offset=0&searchValue=Weather&country=USA" \
-H "Authorization: Bearer <your bearer token>" \
-H "X-USER-ID: <test app>" \
-H "X-INMOBI-ORG-ID: <your org id>" \
-H "Content-Type: application/json"
{
"data": {
"records": [
{
"type": "segment_detailed",
"id": "374c4f34-5ad5-437c-aa20-8f153d04970d",
"segmentCore": {
"type": "segment_third_party",
"startDateTime": "2024-12-31T00:00:00.000Z",
"endDateTime": "2099-12-31T00:00:00.000Z",
"brands": [],
"categories": [],
"tags": [],
"widgets": [],
"taxonomyType": "custom",
"datasets": [],
"name": "TWC > Weather Targeting > Relative > Current > Unseasonably Warm and Sunny",
"description": "TWC > Weather Targeting > Relative > Current > Unseasonably Warm and Sunny",
"providerId": "0f6e5ac5-cf01-494e-895e-840c416c4f4b",
"pricing": {
"value": 0,
"pricingModel": "CPM"
},
"membershipTTLInHours": 8760,
"segmentType": "PUBLIC",
"primaryCountry": 94,
"clientType": "IDI",
"externalId": "de97d203-aa46-488d-b5de-3c9399e05d03",
"externalSegmentId": "AU_RTD_9crq",
"snapshotEpoch": 0
},
"createdOn": 1737023889992,
"updatedOn": 1737023889992,
"createdBy": "NA",
"updatedBy": "NA",
"isDeprecated": false,
"segmentLifeCycleStage": "CREATED",
"stats": {
"reach": 0
},
"consumerAccountIdList": []
},
{
"type": "segment_detailed",
"id": "e246b77b-b71a-4537-8789-1ea07c5e2219",
"segmentCore": {
"type": "segment_third_party",
"startDateTime": "2024-12-31T00:00:00.000Z",
"endDateTime": "2099-12-31T00:00:00.000Z",
"brands": [],
"categories": [],
"tags": [],
"widgets": [],
"taxonomyType": "custom",
"datasets": [],
"name": "TWC > Weather Targeting > Relative > Current > Unseasonably Cool",
"description": "TWC > Weather Targeting > Relative > Current > Unseasonably Cool",
"providerId": "0f6e5ac5-cf01-494e-895e-840c416c4f4b",
"pricing": {
"value": 0,
"pricingModel": "CPM"
},
"membershipTTLInHours": 8760,
"segmentType": "PUBLIC",
"primaryCountry": 94,
"clientType": "IDI",
"externalId": "de97d203-aa46-488d-b5de-3c9399e05d03",
"externalSegmentId": "AU_RTD_9crp",
"snapshotEpoch": 0
},
"createdOn": 1737023889626,
"updatedOn": 1737023889626,
"createdBy": "NA",
"updatedBy": "NA",
"isDeprecated": false,
"segmentLifeCycleStage": "CREATED",
"stats": {
"reach": 0
},
"consumerAccountIdList": []
}
],
"pagination": {
"pageNum": 0,
"pageSize": 2,
"totalPages": 264,
"totalRecords": 528
}
}
}
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.