API Reference
Advertiser APIs HomeGuidesAPI ReferenceChangelog

List segments

get
https://{buzz_key}.api.beeswax.com/rest/v2/segments

Returns a list of segments for the current account. Supports filtering by segment category, advertiser, alternative ID, and other attributes. Includes both locally owned and shared segments.

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

Multiple values may be separated by commas.

account_id__in
number
account_id__not_in
array of numbers

Multiple values may be separated by commas.

account_id__not_in
boolean
number
number
number
number
advertiser_id__in
array of numbers

Multiple values may be separated by commas.

advertiser_id__in
boolean
number
number
number
advertiser_id__not_in
array of numbers

Multiple values may be separated by commas.

advertiser_id__not_in
boolean

Only return segments whose aggregate excludes flag matches this value.

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
string

Only return segments whose segment category key exactly matches this value.

category_keys__in
array of strings

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

category_keys__in
boolean

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

category_keys__not_in
array of strings

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

category_keys__not_in
number

Only return segments whose CPM cost exactly matches this value.

number

Only return segments whose CPM cost is greater than this value.

cpm_cost__in
array of numbers

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

cpm_cost__in
number

Only return segments whose CPM cost is less than this value.

number

Exclude segments whose CPM cost exactly matches this value.

cpm_cost__not_in
array of numbers

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

cpm_cost__not_in
date-time
date-time
date-time
boolean
date-time
date-time
date-time | null
enum

The date and time the object was first created

  • today - From last midnight to next midnight
  • yesterday - The last complete calendar day
  • last_24_hours - The last 24 hours (as opposed to today, which is from midnight to midnight)
  • this_week - From midnight the previous Sunday until midnight the coming Sunday
  • last_week - The last complete calendar week
  • this_year - From the January 1 to December 31 this year
  • last_year - The last complete calendar year
  • this_month - From the first day to the last day of the current month
  • last_month - The last complete calendar month
  • this_quarter - From the first day to the last day of the current quarter
  • last_quarter - The last complete calendar quarter
  • last_7_days - From midnight 7 days ago to the present
  • last_7_complete_days - From midnight 7 days ago to last midnight
  • last_14_days - From midnight 14 days ago to the present
  • last_14_complete_days - From midnight 14 days ago to last midnight
  • last_30_days - From midnight 30 days ago to the present
  • last_30_complete_days - From midnight 30 days ago to last midnight
  • last_90_days - From midnight 90 days ago to the present
  • last_90_complete_days - From midnight 90 days ago to last midnight
  • last_365_days - From midnight 365 days ago to the present
  • last_365_complete_days - From midnight 365 days ago to last midnight
  • past - Any date in the past. Useful for Buzz queries against end_date and similar fields
  • future - Any date in the future. Useful for Buzz queries against end_date and similar fields
  • until_past_24_hours - From the very first date in the past and up until past 24 hours
string

Only return segments whose description exactly matches this value.

string

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

description__in
array of strings

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

description__in
boolean

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

string

Exclude segments whose description exactly matches this value.

string

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

description__not_in
array of strings

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

description__not_in
boolean

Only return segments whose extensible flag matches this value.

number
number
number
id__in
array of numbers

Multiple values may be separated by commas.

id__in
number
number
number
id__not_in
array of numbers

Multiple values may be separated by commas.

id__not_in
string

Only return records whose key exactly matches this value.

key__in
array of strings

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

key__in
boolean

When true, only return records with an empty or missing key. When false, exclude them.

string

Exclude records whose key exactly matches this value.

key__not_in
array of strings

Exclude records whose key matches one of these values. Multiple values may be separated by commas.

key__not_in
string

Only return records whose name exactly matches this value.

string

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

name__in
array of strings

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

name__in
boolean

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

string

Exclude records whose name exactly matches this value.

string

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

name__not_in
array of strings

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

name__not_in
string

Which field to use when ordering the results.

integer

Only return segments whose TTL in days exactly matches this value.

integer

Only return segments whose TTL in days is greater than this value.

integer

Only return segments whose TTL in days is less than this value.

integer

Exclude segments whose TTL in days exactly matches this value.

date-time
date-time
date-time
boolean
date-time
date-time
date-time | null
enum

The date and time the object was last updated

  • today - From last midnight to next midnight
  • yesterday - The last complete calendar day
  • last_24_hours - The last 24 hours (as opposed to today, which is from midnight to midnight)
  • this_week - From midnight the previous Sunday until midnight the coming Sunday
  • last_week - The last complete calendar week
  • this_year - From the January 1 to December 31 this year
  • last_year - The last complete calendar year
  • this_month - From the first day to the last day of the current month
  • last_month - The last complete calendar month
  • this_quarter - From the first day to the last day of the current quarter
  • last_quarter - The last complete calendar quarter
  • last_7_days - From midnight 7 days ago to the present
  • last_7_complete_days - From midnight 7 days ago to last midnight
  • last_14_days - From midnight 14 days ago to the present
  • last_14_complete_days - From midnight 14 days ago to last midnight
  • last_30_days - From midnight 30 days ago to the present
  • last_30_complete_days - From midnight 30 days ago to last midnight
  • last_90_days - From midnight 90 days ago to the present
  • last_90_complete_days - From midnight 90 days ago to last midnight
  • last_365_days - From midnight 365 days ago to the present
  • last_365_complete_days - From midnight 365 days ago to last midnight
  • past - Any date in the past. Useful for Buzz queries against end_date and similar fields
  • future - Any date in the future. Useful for Buzz queries against end_date and similar fields
  • until_past_24_hours - From the very first date in the past and up until past 24 hours
string

Only return segments whose verb usage exactly matches this value.

verb__in
array of strings

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

verb__in
boolean

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

string

Exclude segments whose verb usage exactly matches this value.

verb__not_in
array of strings

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

verb__not_in
Responses

400

Invalid filter or query parameters.

401

Authentication credentials were not provided.

403

Permission denied.

Updated 7 days ago

Did this page help you?
Language
Credentials
:
URL
LoadingLoading…
Response
Choose an example:
application/json

Updated 7 days ago

Did this page help you?