search Audience Segments
POST {{baseUrl}}/2024-04/marketing-solutions/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>"], "advertiserIds"=>["<string>", "<string>"], "audienceSegmentTypes"=>["Location", "Prospecting"]}}}
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":{"name":"\u003cstring\u003e","description":"\u003cstring\u003e","type":"Behavioral","createdAt":"\u003cdateTime\u003e","updatedAt":"\u003cdateTime\u003e","advertiserId":"\u003cstring\u003e","inMarket":{"country":"\u003cstring\u003e","buyingPower":["Unknown","VeryHigh"],"gender":"Female","interestIds":["\u003cstring\u003e","\u003cstring\u003e"],"brandIds":["\u003cstring\u003e","\u003cstring\u003e"],"priceRange":["Low","Low"]},"prospecting":{"daysSinceLastVisitMin":"\u003cinteger\u003e","daysSinceLastVisitMax":"\u003cinteger\u003e","usersType":"ProspectsOrNonBuyers"},"contactList":{"isReadOnly":"\u003cboolean\u003e"},"location":{"pointsOfInterest":[{"name":"\u003cstring\u003e","latitude":"\u003cdouble\u003e","longitude":"\u003cdouble\u003e"},{"name":"\u003cstring\u003e","latitude":"\u003cdouble\u003e","longitude":"\u003cdouble\u003e"}],"radiusInKm":"\u003cinteger\u003e","registryType":"Unknown"},"behavioral":{"category":"Lifestyles","country":"\u003cstring\u003e","startDate":"\u003cdateTime\u003e","endDate":"\u003cdateTime\u003e"},"retargeting":{"visitorsType":"All","daysSinceLastVisitMin":"\u003cinteger\u003e","daysSinceLastVisitMax":"\u003cinteger\u003e"},"lookalike":{"seedSegmentId":"\u003cstring\u003e","targetSize":"\u003clong\u003e"}},"id":"\u003cstring\u003e","type":"\u003cstring\u003e"},{"attributes":{"name":"\u003cstring\u003e","description":"\u003cstring\u003e","type":"Unknown","createdAt":"\u003cdateTime\u003e","updatedAt":"\u003cdateTime\u003e","advertiserId":"\u003cstring\u003e","inMarket":{"country":"\u003cstring\u003e","buyingPower":["Unknown","Unknown"],"gender":"Female","interestIds":["\u003cstring\u003e","\u003cstring\u003e"],"brandIds":["\u003cstring\u003e","\u003cstring\u003e"],"priceRange":["Medium","Medium"]},"prospecting":{"daysSinceLastVisitMin":"\u003cinteger\u003e","daysSinceLastVisitMax":"\u003cinteger\u003e","usersType":"ProspectsOrNonBuyers"},"contactList":{"isReadOnly":"\u003cboolean\u003e"},"location":{"pointsOfInterest":[{"name":"\u003cstring\u003e","latitude":"\u003cdouble\u003e","longitude":"\u003cdouble\u003e"},{"name":"\u003cstring\u003e","latitude":"\u003cdouble\u003e","longitude":"\u003cdouble\u003e"}],"radiusInKm":"\u003cinteger\u003e","registryType":"Unknown"},"behavioral":{"category":"BuyingPatterns","country":"\u003cstring\u003e","startDate":"\u003cdateTime\u003e","endDate":"\u003cdateTime\u003e"},"retargeting":{"visitorsType":"NonBuyers","daysSinceLastVisitMin":"\u003cinteger\u003e","daysSinceLastVisitMax":"\u003cinteger\u003e"},"lookalike":{"seedSegmentId":"\u003cstring\u003e","targetSize":"\u003clong\u003e"}},"id":"\u003cstring\u003e","type":"\u003cstring\u003e"}],"warnings":[{"traceId":"\u003cstring\u003e","traceIdentifier":"\u003cstring\u003e","type":"availability","code":"\u003cstring\u003e","instance":"\u003cstring\u003e","title":"\u003cstring\u003e","detail":"\u003cstring\u003e","source":{"proident_846":"\u003cstring\u003e","reprehenderit6":"\u003cstring\u003e","officia_7e":"\u003cstring\u003e","id45":"\u003cstring\u003e","occaecat_aa":"\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":{"exercitation_39":"\u003cstring\u003e","eiusmod_12":"\u003cstring\u003e","tempor_6":"\u003cstring\u003e"},"stackTrace":"\u003cstring\u003e"}],"errors":[{"traceId":"\u003cstring\u003e","traceIdentifier":"\u003cstring\u003e","type":"authorization","code":"\u003cstring\u003e","instance":"\u003cstring\u003e","title":"\u003cstring\u003e","detail":"\u003cstring\u003e","source":{"Duis112":"\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":{"Ut_5":"\u003cstring\u003e","irure_54":"\u003cstring\u003e"},"stackTrace":"\u003cstring\u003e"}]}