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

key__in

array of strings

Multiple values may be separated by commas.

key__in

key__isempty

boolean

key__not

string

key__not_in

array of strings

Multiple values may be separated by commas.

key__not_in

name

string

order

string

Which field to use when ordering the results.

parent_key

string

parent_key__in

array of strings

Multiple values may be separated by commas.

parent_key__in

parent_key__isempty

boolean

parent_key__not

string

parent_key__not_in

array of strings

Multiple values may be separated by commas.

parent_key__not_in

type

string

type__isempty

boolean

type__not

string

Responses

400

Invalid filter or query parameters.

401

Authentication required.

403

Permission denied.

500

Internal server error.

Language

Credentials

URL

Loading…

Response

Choose an example:

application/json

200Segment tree retrieved successfully.