Audience Api Get Audiences By Account Id
GET {{baseUrl}}/2022-07/retail-media/accounts/:accountId/audiences?limitToId=<string>&limitToId=<string>&pageSize=<integer>&pageIndex=<integer>
Get a page of audiences for a given account ID
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
limitToId | string | Limits results to the entity IDs specified; parameter key is repeated, eg. limitToId=1&limitToId=2 | |
limitToId | string | Limits results to the entity IDs specified; parameter key is repeated, eg. limitToId=1&limitToId=2 | |
pageSize | string | Specifies the maximum number of entities returned in a single page; defaults to 25 entities per page | |
pageIndex | string | Returns the specified page of results given a pageSize; pages are 0-indexed |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"data":[{"attributes":{"name":"\u003cstring\u003e","retailerId":"\u003cstring\u003e","userBehaviorDetails":{"lookbackWindow":"P150D","targetIds":["\u003cstring\u003e","\u003cstring\u003e"],"targetType":"category","userType":"buyer"},"customerListDetails":{"size":"\u003cstring\u003e"}},"audienceType":"customerList","id":"\u003cstring\u003e","type":"\u003cstring\u003e"},{"attributes":{"name":"\u003cstring\u003e","retailerId":"\u003cstring\u003e","userBehaviorDetails":{"lookbackWindow":"P60D","targetIds":["\u003cstring\u003e","\u003cstring\u003e"],"targetType":"category","userType":"viewer"},"customerListDetails":{"size":"\u003cstring\u003e"}},"audienceType":"customerList","id":"\u003cstring\u003e","type":"\u003cstring\u003e"}],"metadata":{"currentPageSize":"\u003cinteger\u003e","currentPageIndex":"\u003cinteger\u003e","totalItemsAcrossAllPages":"\u003clong\u003e","totalPages":"\u003clong\u003e","nextPage":"\u003cstring\u003e","previousPage":"\u003cstring\u003e"},"errors":[{"traceId":"\u003cstring\u003e","type":"deprecation","code":"\u003cstring\u003e","instance":"\u003cstring\u003e","title":"\u003cstring\u003e","detail":"\u003cstring\u003e","source":{"doloref":"\u003cstring\u003e","laboris6c8":"\u003cstring\u003e","consequatb":"\u003cstring\u003e","consequatd6":"\u003cstring\u003e"},"stackTrace":"\u003cstring\u003e"},{"traceId":"\u003cstring\u003e","type":"deprecation","code":"\u003cstring\u003e","instance":"\u003cstring\u003e","title":"\u003cstring\u003e","detail":"\u003cstring\u003e","source":{"qui_3":"\u003cstring\u003e","ida":"\u003cstring\u003e"},"stackTrace":"\u003cstring\u003e"}],"warnings":[{"traceId":"\u003cstring\u003e","type":"availability","code":"\u003cstring\u003e","instance":"\u003cstring\u003e","title":"\u003cstring\u003e","detail":"\u003cstring\u003e","source":{"velit_a":"\u003cstring\u003e","enim9ee":"\u003cstring\u003e"},"stackTrace":"\u003cstring\u003e"},{"traceId":"\u003cstring\u003e","type":"quota","code":"\u003cstring\u003e","instance":"\u003cstring\u003e","title":"\u003cstring\u003e","detail":"\u003cstring\u003e","source":{"Lorem_6":"\u003cstring\u003e"},"stackTrace":"\u003cstring\u003e"}]}