API Reference
Advertiser APIs HomeGuidesAPI ReferenceChangelog

List segment categories

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

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

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
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
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
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
boolean

When true, only return segment categories with an empty or missing note text. When false, exclude them.

string

Which field to use when ordering the results.

string

Only return segment categories whose parent category key exactly matches this value.

parent_key__in
array of strings

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

parent_key__in
boolean

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

string

Exclude segment categories whose parent category key exactly matches this value.

parent_key__not_in
array of strings

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

parent_key__not_in
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
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?