Navigate segment tree

get

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

Returns the hierarchical segment tree including segment categories and segments. Includes both locally owned and shared segments for the active account.

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.

key

string

Only return segment tree nodes whose key exactly matches this value.

key__in

array of strings

Only return segment tree nodes whose key matches one of these values. Multiple values may be separated by commas.

key__in

key__isempty

boolean

When true, only return segment tree nodes with an empty or missing key. When false, exclude them.

key__not

string

Exclude segment tree nodes whose key exactly matches this value.

key__not_in

array of strings

Exclude segment tree nodes whose key matches one of these values. Multiple values may be separated by commas.

key__not_in

name

string

Only return segment tree nodes whose name exactly matches this value.

order

string

Which field to use when ordering the results.

parent_key

string

Only return segment tree nodes whose parent key exactly matches this value.

parent_key__in

array of strings

Only return segment tree nodes whose parent key matches one of these values. Multiple values may be separated by commas.

parent_key__in

parent_key__isempty

boolean

When true, only return segment tree nodes with an empty or missing parent key. When false, exclude them.

parent_key__not

string

Exclude segment tree nodes whose parent key exactly matches this value.

parent_key__not_in

array of strings

Exclude segment tree nodes whose parent key matches one of these values. Multiple values may be separated by commas.

parent_key__not_in

type

string

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

type__isempty

boolean

When true, only return segment tree nodes with an empty or missing type. When false, exclude them.

type__not

string

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

Responses

400

Invalid filter or query parameters.

401

Authentication credentials were not provided.

403

Permission denied.

500

Internal server error.

Language

Credentials

URL

Loading…

Response

Choose an example:

application/json

200Segment tree retrieved successfully.