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

Common Fields in GET Responses

Many Buzz Objects include a set of common fields which are always present in GET requests. These common fields include:

  • alternative_id
  • notes
  • create_date
  • update_date
  • push_update
  • push_status


Most of the Objects in Buzz support the concept of an Alternative ID. This field is essentially a way for a Buzz user to tie the object 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 it's 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.


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.


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":"today").


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


Not currently used.


Not currently used.


The account the object belongs to. You cannot make any requests across Accounts.


See: Buzz Key.