List of IOs
GET {{campaign_url}}/insertionOrders?advertiserId={{advertiserId}}&offset=0&limit=2&sortOrder=asc&sortKey=id
Retrieve a list of IOs
You can retrieve all of the IOs within a specified market or advertiser by sending this GET
request.
Note: marketId
and advertiserId
cannot be used at the same time for a single request.
If you want to view all IOs under a given market and have access to multiple markets, you must specify a value for marketId
.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
marketId | number | Limits response results to IOs within the market specified. |
Cannot be defined when advertiserId is defined. |
| advertiserId
| string | | Limits response results to IOs under the advertiser specified. If left unchecked/empty, IOs under all advertisers are returned.
Cannot be defined when marketId is defined. |
| offset
| number | | The starting index in the list of IOs. |
| limit
| number | | The number of IOs to return. |
| sortOrder
| string | | Direction by which results should be sorted.
Allowed values: asc, desc |
| sortKey
| string | | Field by which results should be sorted.
Allowed values: advertiserId, dealName, id, name |
RESPONSES
status: OK
{"queryTotal":2,"data":[{"id":"1608768377","marketId":"1","resourceType":"insertionOrder","status":"stopStartDate","name":"doc test IO","managerAccountId":"1234","frequencyType":"device","impressionFrequency":{"personOrDeviceFrequencyCapDetails":{"cap":1,"period":1,"periodUnits":"days"}},"cpaGoalAmount":5,"attributionService":"visualIqMta","budget":{"clientMargin":10,"schedules":[{"startDate":"2022-08-20T13:41:30Z","endDate":"2022-08-28T03:59:59Z","budget":100,"impressionCap":10}]},"creativeRotationEvent":"clicks","advertiserId":"1608764878","createdAt":"2022-08-16T17:42:42Z","updatedAt":"2022-08-16T17:55:13Z","currency":"usd","customPackageMode":"threeLevel","pacingBasis":"impression"},{"id":"1608768392","marketId":"1","resourceType":"insertionOrder","status":"pause","name":"doc test IO - Copy 1","managerAccountId":"1234","frequencyType":"device","impressionFrequency":{"personOrDeviceFrequencyCapDetails":{"cap":1,"period":1,"periodUnits":"days"}},"cpaGoalAmount":5,"attributionService":"visualIqMta","budget":{"clientMargin":10,"schedules":[{"startDate":"2022-08-20T13:41:30Z","endDate":"2022-08-28T03:59:59Z","budget":100,"impressionCap":10}]},"creativeRotationEvent":"clicks","advertiserId":"1608764878","createdAt":"2022-08-16T18:26:44Z","updatedAt":"2022-08-16T18:26:44Z","currency":"usd","customPackageMode":"threeLevel","pacingBasis":"impression"}],"errors":[],"links":{"self":"https://services.amobee.com/campaign/v5/api/insertionOrders?advertiserId=1608767822\u0026offset=0\u0026limit=2\u0026sortOrder=desc\u0026sortKey=id"}}