API Reference
Buyer Cloud HomeGuidesAPI ReferenceChangelog

Search custom segments

get
https://{buzz_key}.api.beeswax.com/rest/v2/ref/segment-search

Search across custom segments that are either directly owned by the active account or shared with it. Returns a flat list of matching segment nodes.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
number

Only return segments owned by a specific advertiser.

number

Only return segments with no owner or owned by a specific advertiser.

string
string
alternative_id__in
array of strings

Multiple values may be separated by commas.

alternative_id__in
boolean
string
string
alternative_id__not_in
array of strings

Multiple values may be separated by commas.

alternative_id__not_in
string
string
number
number
number
boolean

Filter to the set of objects the user has "favorited".

string
string
string
name__in
array of strings

Multiple values may be separated by commas.

name__in
boolean
string
string
name__not_in
array of strings

Multiple values may be separated by commas.

name__not_in
string

Which field to use when ordering the results.

string

A search term.

string
boolean
string
number
number
number
number
number
number
date-time
date-time
Responses

400

Invalid search or filter parameters.

401

Authentication required.

403

Permission denied.

500

Internal server error.

Updated about 2 months ago

Language
Credentials
:
URL
LoadingLoading…
Response
Choose an example:
application/json

Updated about 2 months ago