Campaigns Get Api202301External Account Campaigns By Account Id
GET {{baseUrl}}/2023-07/retail-media/accounts/:account-id/campaigns?limitToId=<string>&limitToId=<string>&pageIndex=0&pageSize=25
Get all the editable and creatable campaign attributes including all types of budgets for each campaigns in relation to the account id, limited by the campaign ids.
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 | number | The 0 indexed page index you would like to receive given the page size | |
pageSize | number | The maximum number of items you would like to receive in this request |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"metadata":{"currentPageSize":"\u003cinteger\u003e","currentPageIndex":"\u003cinteger\u003e","totalItemsAcrossAllPages":"\u003clong\u003e","totalPages":"\u003clong\u003e","nextPage":"\u003cstring\u003e","previousPage":"\u003cstring\u003e"},"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","isAutoDailyPacing":"\u003cboolean\u003e","startDate":"\u003cdateTime\u003e","endDate":"\u003cdateTime\u003e","status":"inactive","type":"auction","drawableBalanceIds":["\u003cstring\u003e","\u003cstring\u003e"],"clickAttributionWindow":"30D","viewAttributionWindow":"None","budget":"\u003cnumber\u003e","monthlyPacing":"\u003cnumber\u003e","dailyPacing":"\u003cnumber\u003e","clickAttributionScope":"sameSkuCategory","viewAttributionScope":"sameSku","companyName":"\u003cstring\u003e"}},{"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","isAutoDailyPacing":"\u003cboolean\u003e","startDate":"\u003cdateTime\u003e","endDate":"\u003cdateTime\u003e","status":"active","type":"auction","drawableBalanceIds":["\u003cstring\u003e","\u003cstring\u003e"],"clickAttributionWindow":"30D","viewAttributionWindow":"None","budget":"\u003cnumber\u003e","monthlyPacing":"\u003cnumber\u003e","dailyPacing":"\u003cnumber\u003e","clickAttributionScope":"sameSkuCategoryBrand","viewAttributionScope":"sameSku","companyName":"\u003cstring\u003e"}}],"errors":[{"traceId":"\u003cstring\u003e","type":"quota","code":"\u003cstring\u003e","instance":"\u003cstring\u003e","title":"\u003cstring\u003e","detail":"\u003cstring\u003e","source":{"nostrudc0":"\u003cstring\u003e","dolor_ef_":"\u003cstring\u003e","laborum_54":"\u003cstring\u003e"},"stackTrace":"\u003cstring\u003e"},{"traceId":"\u003cstring\u003e","type":"deprecation","code":"\u003cstring\u003e","instance":"\u003cstring\u003e","title":"\u003cstring\u003e","detail":"\u003cstring\u003e","source":{"nisid":"\u003cstring\u003e"},"stackTrace":"\u003cstring\u003e"}],"warnings":[{"traceId":"\u003cstring\u003e","type":"authorization","code":"\u003cstring\u003e","instance":"\u003cstring\u003e","title":"\u003cstring\u003e","detail":"\u003cstring\u003e","source":{"culpa_62":"\u003cstring\u003e","incididunt3c":"\u003cstring\u003e","Duis_":"\u003cstring\u003e"},"stackTrace":"\u003cstring\u003e"},{"traceId":"\u003cstring\u003e","type":"deprecation","code":"\u003cstring\u003e","instance":"\u003cstring\u003e","title":"\u003cstring\u003e","detail":"\u003cstring\u003e","source":{"occaecat_6a9":"\u003cstring\u003e"},"stackTrace":"\u003cstring\u003e"}]}