Say 👋 hello to BusyBee, your AI-powered learning & teaching companion for Buzz. Learn more!

Administrator

How do I filter Data streams to send specific Events and Properties?

  • Updated:
    info
    Created:

A Data stream is a process to transmit Buzz system events (formatted as JSON objects) that can be used for data analysis, statistical tracking, or synchronization with another system.

In Buzz, Administrators can use different Stream types and configure multiple Data streams to allow data for various Events to be sent, near real-time, to one or more third-party services.

Buzz lets you filter the data by Events and Properties within those Events to avoid using storage for data you don't need.

Note: If you Enable and Save your Data stream without adding filters, Buzz automatically sends data for all Events to the defined destination. This can result in large amounts of unnecessary storage.

Learn more: How do I filter Data streams to send specific Events and Properties?

Filter your Data streams to send only the data you need

Once you have configured your Data stream, you can filter it to send only the data you need.

To filter your Data streams you specify Events and Properties within that event:

  1. Click Add filter to create a custom filter. You can create as many as you need.
  2. In Event type, select the overall Event that you want to collect date around.
  3. In Properties, manually enter the specific Properties you want to collect data for in a comma-separated list. Review the example below.
  4. Once you're done adding filters to the Data stream, you can:
    • Click Test to make sure the Data stream is set up correctly and working. This sends a single event, so you can verify that your configuration is correct.
    • Click Save. If the Enabled box is checked, your Data stream begins sending data; if not, your configuration is saved, and no data is sent.

Events and Properties example

Example

There are two types of Properties:

  • (parent) Properties, which can stand alone in the field.
  • (child) Properties, which are to be entered after a (parent) Property separated by a period.

The example below is set up to return data for two Event types with three Properties specified for each:

  1. Event type 1: Domain created
  2. Properties:
    • domainId (parent)
    • newDomain.name (child)
    • newDomain.data (child)
  3. Event type 2: Course created
  4. Properties:
    • courseID (parent)
    • newCourse.title (child)
    • newCourse.data (child)

The tables in Data Events and Properties list and define all of the options for filtering your Data streams.

Data Events and Properties

You can set up filters to return data for the Events listed below. You can further filter within each Event by defining the specific Properties you want sent. The links below take you to API documentation describing each event's properties.

The Event types listed below are subject change.

forum

Have a question or feedback? Let us know over in Discussions!