Search V1
POST {{baseUrl}}/preview/retail-media/accounts/:account-id/audience-segments/search?limit=50&offset=0
Returns a list of segments that match the provided filters. If present, the filters are AND'ed together when applied.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
limit | number | The number of elements to be returned. The default is 50 and the maximum is 100. | |
offset | number | The (zero-based) offset into the collection. The default is 0. |
Request Body
{"data"=>{"type"=>"<string>", "attributes"=>{"audienceSegmentIds"=>["<string>", "<string>"], "retailerIds"=>["<string>", "<string>"], "audienceSegmentTypes"=>["ContactList", "Unknown"]}}}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string | ||
Accept | string |
RESPONSES
status: OK
{"meta":{"totalItems":"\u003cinteger\u003e","limit":"\u003cinteger\u003e","offset":"\u003cinteger\u003e"},"data":[{"attributes":{"accountId":"\u003cstring\u003e","name":"\u003cstring\u003e","description":"\u003cstring\u003e","retailerId":"\u003cstring\u003e","type":"UserBehavior","createdAt":"\u003cdateTime\u003e","updatedAt":"\u003cdateTime\u003e","createdById":"\u003cstring\u003e","contactList":{"isReadOnly":"\u003cboolean\u003e","type":"Unknown","sharingStatus":"SharedWithDemandAccounts"},"userBehavior":{"shopperActivity":"Unknown","lookbackDays":"Last7Days","categoryIds":["\u003cstring\u003e","\u003cstring\u003e"],"brandIds":["\u003cstring\u003e","\u003cstring\u003e"],"minPrice":"\u003cdouble\u003e","maxPrice":"\u003cdouble\u003e"},"channels":["Offsite","Offsite"]},"id":"\u003cstring\u003e","type":"\u003cstring\u003e"},{"attributes":{"accountId":"\u003cstring\u003e","name":"\u003cstring\u003e","description":"\u003cstring\u003e","retailerId":"\u003cstring\u003e","type":"ContactList","createdAt":"\u003cdateTime\u003e","updatedAt":"\u003cdateTime\u003e","createdById":"\u003cstring\u003e","contactList":{"isReadOnly":"\u003cboolean\u003e","type":"Unknown","sharingStatus":"NotShared"},"userBehavior":{"shopperActivity":"Buy","lookbackDays":"Last180Days","categoryIds":["\u003cstring\u003e","\u003cstring\u003e"],"brandIds":["\u003cstring\u003e","\u003cstring\u003e"],"minPrice":"\u003cdouble\u003e","maxPrice":"\u003cdouble\u003e"},"channels":["Unknown","Unknown"]},"id":"\u003cstring\u003e","type":"\u003cstring\u003e"}],"warnings":[{"traceId":"\u003cstring\u003e","traceIdentifier":"\u003cstring\u003e","type":"validation","code":"\u003cstring\u003e","instance":"\u003cstring\u003e","title":"\u003cstring\u003e","detail":"\u003cstring\u003e","source":{"tempor_278":"\u003cstring\u003e","Ut_cc":"\u003cstring\u003e"},"stackTrace":"\u003cstring\u003e"},{"traceId":"\u003cstring\u003e","traceIdentifier":"\u003cstring\u003e","type":"unknown","code":"\u003cstring\u003e","instance":"\u003cstring\u003e","title":"\u003cstring\u003e","detail":"\u003cstring\u003e","source":{"laborum_ca":"\u003cstring\u003e"},"stackTrace":"\u003cstring\u003e"}],"errors":[{"traceId":"\u003cstring\u003e","traceIdentifier":"\u003cstring\u003e","type":"access-control","code":"\u003cstring\u003e","instance":"\u003cstring\u003e","title":"\u003cstring\u003e","detail":"\u003cstring\u003e","source":{"velit_1":"\u003cstring\u003e"},"stackTrace":"\u003cstring\u003e"},{"traceId":"\u003cstring\u003e","traceIdentifier":"\u003cstring\u003e","type":"deprecation","code":"\u003cstring\u003e","instance":"\u003cstring\u003e","title":"\u003cstring\u003e","detail":"\u003cstring\u003e","source":{"Duisc":"\u003cstring\u003e","sunt_d":"\u003cstring\u003e"},"stackTrace":"\u003cstring\u003e"}]}