Get Api V2External Campaign Preferred Line Items By Campaign Id
GET {{baseUrl}}/preview/retail-media/campaigns/:campaign-id/preferred-line-items?limitToId=<string>&limitToId=<string>&pageIndex=<integer>&pageSize=<integer>
Gets page of preferred line item objects for the given campaign 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
{"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":{"name":"\u003cstring\u003e","startDate":"\u003cdate\u003e","endDate":"\u003cdate\u003e","status":"active","targetRetailerId":"\u003cstring\u003e","campaignId":"\u003cstring\u003e","createdAt":"\u003cdateTime\u003e","updatedAt":"\u003cdateTime\u003e","pacing":"standard","capping":{"type":"session","count":"\u003cinteger\u003e"},"page":{"pageType":"merchandising","categories":[{"categoryId":"\u003cstring\u003e","includeChildren":true},{"categoryId":"\u003cstring\u003e","includeChildren":true}],"searchKeywords":["\u003cstring\u003e","\u003cstring\u003e"]},"budget":"\u003cnumber\u003e","budgetSpent":"\u003cnumber\u003e","budgetRemaining":"\u003cnumber\u003e","creativeId":"\u003cstring\u003e"}},{"id":"\u003cstring\u003e","type":"\u003cstring\u003e","attributes":{"name":"\u003cstring\u003e","startDate":"\u003cdate\u003e","endDate":"\u003cdate\u003e","status":"paused","targetRetailerId":"\u003cstring\u003e","campaignId":"\u003cstring\u003e","createdAt":"\u003cdateTime\u003e","updatedAt":"\u003cdateTime\u003e","pacing":"standard","capping":{"type":"session","count":"\u003cinteger\u003e"},"page":{"pageType":"favorites","categories":[{"categoryId":"\u003cstring\u003e","includeChildren":true},{"categoryId":"\u003cstring\u003e","includeChildren":true}],"searchKeywords":["\u003cstring\u003e","\u003cstring\u003e"]},"budget":"\u003cnumber\u003e","budgetSpent":"\u003cnumber\u003e","budgetRemaining":"\u003cnumber\u003e","creativeId":"\u003cstring\u003e"}}],"warnings":[{"traceId":"\u003cstring\u003e","traceIdentifier":"\u003cstring\u003e","type":"deprecation","code":"\u003cstring\u003e","instance":"\u003cstring\u003e","title":"\u003cstring\u003e","detail":"\u003cstring\u003e","source":{"Lorem_520":"\u003cstring\u003e","enim5":"\u003cstring\u003e"},"stackTrace":"\u003cstring\u003e"},{"traceId":"\u003cstring\u003e","traceIdentifier":"\u003cstring\u003e","type":"availability","code":"\u003cstring\u003e","instance":"\u003cstring\u003e","title":"\u003cstring\u003e","detail":"\u003cstring\u003e","source":{"dolore_c":"\u003cstring\u003e"},"stackTrace":"\u003cstring\u003e"}],"errors":[{"traceId":"\u003cstring\u003e","traceIdentifier":"\u003cstring\u003e","type":"availability","code":"\u003cstring\u003e","instance":"\u003cstring\u003e","title":"\u003cstring\u003e","detail":"\u003cstring\u003e","source":{"dolord1f":"\u003cstring\u003e","officiadc5":"\u003cstring\u003e","commodo_78":"\u003cstring\u003e"},"stackTrace":"\u003cstring\u003e"},{"traceId":"\u003cstring\u003e","traceIdentifier":"\u003cstring\u003e","type":"quota","code":"\u003cstring\u003e","instance":"\u003cstring\u003e","title":"\u003cstring\u003e","detail":"\u003cstring\u003e","source":{"in__0c":"\u003cstring\u003e","Duis2e2":"\u003cstring\u003e"},"stackTrace":"\u003cstring\u003e"}]}