API Reference
Advertiser APIs HomeGuidesAPI ReferenceChangelog

List creative add-ons

get
https://{buzz_key}.api.beeswax.com/rest/v2/creative-addons

Retrieve a list of all creative add-ons in the account. Supports filtering by name, type, creative type, vendor, currency and status.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
boolean
active__in
array of booleans

Multiple values may be separated by commas.

active__in
active__not_in
array of booleans

Multiple values may be separated by commas.

active__not_in
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
string
string
content__in
array of strings

Multiple values may be separated by commas.

content__in
boolean
string
string
content__not_in
array of strings

Multiple values may be separated by commas.

content__not_in
number
number
number
cpm_cost__in
array of numbers

Multiple values may be separated by commas.

cpm_cost__in
boolean
number
number
number
cpm_cost__not_in
array of numbers

Multiple values may be separated by commas.

cpm_cost__not_in
date-time
date-time
date-time
boolean
date-time
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
creative_type
array of strings or null

Multiple values may be separated by commas.

creative_type
creative_type__in
array of strings or null

Multiple values may be separated by commas.

creative_type__in
boolean
creative_type__not
array of strings or null

Multiple values may be separated by commas.

creative_type__not
creative_type__not_in
array of strings or null

Multiple values may be separated by commas.

creative_type__not_in
string
string
currency__in
array of strings

Multiple values may be separated by commas.

currency__in
boolean
string
string
currency__not_in
array of strings

Multiple values may be separated by commas.

currency__not_in
boolean
global__in
array of booleans

Multiple values may be separated by commas.

global__in
global__not_in
array of booleans

Multiple values may be separated by commas.

global__not_in
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
boolean
include_by_default__in
array of booleans

Multiple values may be separated by commas.

include_by_default__in
include_by_default__not_in
array of booleans

Multiple values may be separated by commas.

include_by_default__not_in
string
string
name__in
array of strings

Multiple values may be separated by commas.

name__in
boolean
string
string
name__not_in
array of strings

Multiple values may be separated by commas.

name__not_in
string

Which field to use when ordering the results.

boolean
secure__in
array of booleans

Multiple values may be separated by commas.

secure__in
secure__not_in
array of booleans

Multiple values may be separated by commas.

secure__not_in
string
type__in
array of strings

Multiple values may be separated by commas.

type__in
boolean
string
type__not_in
array of strings

Multiple values may be separated by commas.

type__not_in
date-time
date-time
date-time
boolean
date-time
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
string
vendor__buzz_key__in
array of strings

Multiple values may be separated by commas.

vendor__buzz_key__in
boolean
string
string
vendor__buzz_key__not_in
array of strings

Multiple values may be separated by commas.

vendor__buzz_key__not_in
number
number
number
vendor_id__in
array of numbers

Multiple values may be separated by commas.

vendor_id__in
boolean
number
number
number
vendor_id__not_in
array of numbers

Multiple values may be separated by commas.

vendor_id__not_in
Responses

400

Invalid data provided.

401

Authentication credentials were not provided.

403

Permission denied.

404

Creative add-on not found.

500

Internal Server Error

Updated 13 days ago

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

Updated 13 days ago

Did this page help you?