"docs.beeswax.com" has a new address: "api-docs.freewheel.tv/beeswax." Please update your bookmarks accordingly.

Common Fields in GET Responses


Migration Notes from 0.5 API

  • The push_update and push_status fields have been removed.
  • New, helpful fields include count, next, and previous.

All GET responses will include the following fields:

  • count
  • next
  • previous

In addition, most Buzz resources will also include a set of common fields, including:

  • alternative_id
  • notes
  • create_date
  • update_date

Below are descriptions of these common fields.


Count of total eligible results. By default the API returns results in increments of 50. See page and page_size parameters on the GET-ting Data from the API guide.


URI for the next set of results.


URI for the previous set of results.


Most of the resources in Buzz support the concept of an Alternative ID. This field is essentially a way for a Buzz user to tie the resources to some external system and to use that other system's ID for querying Buzz. The ID itself has no effect on Buzz's operation and can be omitted if desired.

Typical use cases for Alternative IDs:

  • Buzz is being used in conjunction with another ad serving system and the IDs from that other system need to be stored in Buzz for reconciliation.
  • Buzz is being used with an order entry system of some kind that has its own IDs.
  • Buzz reporting will be combined with reporting from another system and it will be easier to match data with a key.

Note, no validation is performed on Alternative IDs so there is no guarantee of uniqueness or referential integrity between systems. Alternative IDs are limited to 191 characters.


Notes is a text field for putting whatever you want into the object. Typically this is used for data entry notes from the Buzz user, but it can also be used for programmatic updates from the system hitting the API. Notes are limited to 255 characters.


Auto-generated field showing the object's creation date. Read only. Can be included in GET requests, for example to only show objects created today ("create_date__range=yesterday).


Auto-generated field showing the object's last update date. Read only.


The account the object belongs to. You can only make requests across Accounts if enabled as a multi-account user