List of Packages
GET {{campaign_url}}/packages?insertionOrderId={{insertionOrderId}}&offset=0&limit=2&sortOrder=asc&sortKey=id
Retrieve a list of packages
You can retrieve all of the packages within a specified market, advertiser, or IO by sending this GET request.
Note: marketId, advertiserId, and insertionOrderId cannot be used at the same time for a single request.
If you want to view all packages 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 packages within the market specified. |
Cannot be defined when advertiserId or insertionOrderId is defined. |
| advertiserId | string | | Limits response results to packages under the advertiser specified. If left unchecked/empty, packages under all advertisers are returned.
Cannot be defined when marketId or insertionOrderId is defined. |
| insertionOrderId | string | | Limits response results to packages under the IO specified.
Cannot be defined when marketId or advertiserId is defined. |
| offset | number | | The starting index in the list of packages. |
| limit | number | | The number of packages 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: id, name |
RESPONSES
status: OK
{"queryTotal":3,"data":[{"id":"1608782057","marketId":"1","resourceType":"package","status":"pause","name":"in-platform pkg","mediaFormat":"display","budget":{"pacing":"evenImpression","schedules":[{"startDate":"2022-08-26T04:00:00Z","endDate":"2022-09-01T03:59:59Z","budget":1,"impressionCap":1}]},"advertiserId":"1608775066","insertionOrderId":"1608782138","createdAt":"2022-08-26T22:17:56Z","updatedAt":"2022-08-26T22:17:56Z","inventoryType":"openAuctionAndPrivateDeals"},{"id":"1608782159","marketId":"1","resourceType":"package","status":"play","name":"irene test pkg","mediaFormat":"display","budget":{"pacing":"evenImpression","schedules":[{"startDate":"2022-08-27T13:41:00Z","endDate":"2022-10-27T13:41:30Z","budget":50,"impressionCap":10}]},"impressionFrequency":{"personOrDeviceFrequencyCapDetails":{"cap":1,"period":45,"periodUnits":"minutes"}},"advertiserId":"1608775066","insertionOrderId":"1608782138","createdAt":"2022-08-26T23:43:23Z","updatedAt":"2022-08-27T13:54:20Z","inventoryType":"openAuctionAndPrivateDeals"}],"errors":[],"links":{"self":"https://services.amobee.com/campaign/v5/api/packages?insertionOrderId=1608782138\u0026offset=0\u0026limit=2\u0026sortOrder=asc\u0026sortKey=id","next":"https://services.amobee.com/campaign/v5/api/packages?insertionOrderId=1608782138\u0026offset=2\u0026limit=2\u0026sortOrder=asc\u0026sortKey=id"}}