Campaigns Api Get Api V1External Account Campaigns By Account Id
GET {{baseUrl}}/2022-07/retail-media/accounts/:accountId/campaigns?limitToId=<string>&limitToId=<string>&pageIndex=<integer>&pageSize=<integer>
Gets page of campaign objects for the given account id
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
limitToId | string | The ids that you would like to limit your result set to | |
limitToId | string | The ids that you would like to limit your result set to | |
pageIndex | string | The 0 indexed page index you would like to receive given the page size | |
pageSize | string | The maximum number of items you would like to receive in this request |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"data":[{"id":"\u003cstring\u003e","type":"\u003cstring\u003e","attributes":{"accountId":"\u003cstring\u003e","promotedBrandIds":["\u003cstring\u003e","\u003cstring\u003e"],"budgetSpent":"\u003cnumber\u003e","budgetRemaining":"\u003cnumber\u003e","createdAt":"\u003cdateTime\u003e","updatedAt":"\u003cdateTime\u003e","name":"\u003cstring\u003e","status":"unknown","type":"auction","drawableBalanceIds":["\u003cstring\u003e","\u003cstring\u003e"],"clickAttributionWindow":"30D","viewAttributionWindow":"none","budget":"\u003cnumber\u003e","clickAttributionScope":"sameSkuCategoryBrand","viewAttributionScope":"sameSku"}},{"id":"\u003cstring\u003e","type":"\u003cstring\u003e","attributes":{"accountId":"\u003cstring\u003e","promotedBrandIds":["\u003cstring\u003e","\u003cstring\u003e"],"budgetSpent":"\u003cnumber\u003e","budgetRemaining":"\u003cnumber\u003e","createdAt":"\u003cdateTime\u003e","updatedAt":"\u003cdateTime\u003e","name":"\u003cstring\u003e","status":"active","type":"auction","drawableBalanceIds":["\u003cstring\u003e","\u003cstring\u003e"],"clickAttributionWindow":"30D","viewAttributionWindow":"none","budget":"\u003cnumber\u003e","clickAttributionScope":"sameSku","viewAttributionScope":"sameSkuCategory"}}],"errors":[{"traceId":"\u003cstring\u003e","type":"availability","code":"\u003cstring\u003e","instance":"\u003cstring\u003e","title":"\u003cstring\u003e","detail":"\u003cstring\u003e","source":{"Duis__5a":"\u003cstring\u003e","cillum_c85":"\u003cstring\u003e"},"stackTrace":"\u003cstring\u003e"},{"traceId":"\u003cstring\u003e","type":"access-control","code":"\u003cstring\u003e","instance":"\u003cstring\u003e","title":"\u003cstring\u003e","detail":"\u003cstring\u003e","source":{"Ut_9":"\u003cstring\u003e","quie0a":"\u003cstring\u003e"},"stackTrace":"\u003cstring\u003e"}],"warnings":[{"traceId":"\u003cstring\u003e","type":"validation","code":"\u003cstring\u003e","instance":"\u003cstring\u003e","title":"\u003cstring\u003e","detail":"\u003cstring\u003e","source":{"adipisicing_fe7":"\u003cstring\u003e","commodo04":"\u003cstring\u003e","quis80a":"\u003cstring\u003e","ead":"\u003cstring\u003e"},"stackTrace":"\u003cstring\u003e"},{"traceId":"\u003cstring\u003e","type":"availability","code":"\u003cstring\u003e","instance":"\u003cstring\u003e","title":"\u003cstring\u003e","detail":"\u003cstring\u003e","source":{"voluptate548":"\u003cstring\u003e"},"stackTrace":"\u003cstring\u003e"}],"metadata":{"currentPageSize":"\u003cinteger\u003e","currentPageIndex":"\u003cinteger\u003e","totalItemsAcrossAllPages":"\u003clong\u003e","totalPages":"\u003clong\u003e","nextPage":"\u003cstring\u003e","previousPage":"\u003cstring\u003e"}}