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

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

advertiser_id

number

Only return segments owned by a specific advertiser.

advertiser_id__equals_or_null

number

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

alternative_id

string

alternative_id__contains

string

alternative_id__in

array of strings

Multiple values may be separated by commas.

alternative_id__in

alternative_id__isempty

boolean

alternative_id__not

string

alternative_id__not_contains

string

alternative_id__not_in

array of strings

Multiple values may be separated by commas.

alternative_id__not_in

alternative_id__not_startswith

string

alternative_id__startswith

string

cpm

number

Only return segments whose CPM exactly matches this value.

cpm__gt

number

Only return segments whose CPM is greater than this value.

cpm__lt

number

Only return segments whose CPM is less than this value.

favorite

boolean

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

key__contains

string

Only return segments whose key contains this value (case-insensitive).

name

string

Only return segments whose name exactly matches this value.

name__contains

string

Only return segments whose name contains this value (case-insensitive).

name__in

array of strings

Only return segments whose name matches one of these values. Multiple values may be separated by commas.

name__in

name__isempty

boolean

When true, only return segments with an empty or missing name. When false, exclude them.

name__not

string

Exclude segments whose name exactly matches this value.

name__not_contains

string

Exclude segments whose name contains this value (case-insensitive).

name__not_in

array of strings

Exclude segments whose name matches one of these values. Multiple values may be separated by commas.

name__not_in

order

string

Which field to use when ordering the results.

string

A search term.

type

string

Only return segments whose type matches this value ('segment' or 'category').

type__isempty

boolean

When true, only return segments with an empty or missing type. When false, exclude them.

type__not

string

Exclude segments whose type matches this value ('segment' or 'category').

user_count_by_region__apac__gt

number

Only return segments whose APAC user count is greater than this value.

user_count_by_region__apac__lt

number

Only return segments whose APAC user count is less than this value.

user_count_by_region__emea__gt

number

Only return segments whose EMEA user count is greater than this value.

user_count_by_region__emea__lt

number

Only return segments whose EMEA user count is less than this value.

user_count_by_region__nam__gt

number

Only return segments whose North America (NAM) user count is greater than this value.

user_count_by_region__nam__lt

number

Only return segments whose North America (NAM) user count is less than this value.

user_count_update_date__gt

date-time

Only return segments whose user count update date is after this timestamp.

user_count_update_date__lt

date-time

Only return segments whose user count update date is before this timestamp.

Responses

400

Invalid search or filter parameters.

401

Authentication credentials were not provided.

403

Permission denied.

500

Internal server error.

Language

Credentials

URL

Loading…

Response

Choose an example:

application/json

200Segments retrieved successfully.