Administrator

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

  • Updated:
    info_outline
    Created:

Note: This is a beta feature; we welcome your feedback as you test it out. As a beta feature, this process and content is subject to change.

Related article: [Beta] How do I set up and manage Data streams?

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.

Because Data streams automatically send data that you will be storing, Buzz lets you filter the data by Events and Properties within those Events to avoid using storage for data you don't need.

Filter your Data streams 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.

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.

Domain data Events

The following tables define the Properties you can use to filter the data returned for each domain Event.

Domain created

Parent Property Child Property Description
domainId
The ID of the domain that was created.
newDomain name The new name of the domain.

userspace The new userspace of the domain.

parentID The ID of the new parent domain of the domain that was created. 

data The new xml data string for the domain.

flags The new flags for the domain.

modifiedDate The new modification date of the domain (i.e., the date of this change). 

modifiedBy The new modified by user ID for the domain (i.e., the ID of the user who made this change). 

version The new version number of the domain. 

Domain changed

Parent Property Child Property Description
domainId
The ID of the domain that was changed.
oldDomain
name
The old name of the domain.

userspace
The old userspace of the domain.

reference
The old reference of the domain.

parentID
The ID of the old parent domain of the domain that was created.

data
The old xml data string for the domain.

flags
The old flags for the domain.

modifiedDate
The old modification date of the domain (i.e., the date of this change).

modifiedBy
The old modified by user ID for the domain (i.e., the ID of the user who made this change).

version
The old version number of the domain.
newDomain name The new name of the domain.

userspace The new userspace of the domain.

reference The new reference of the domain. 

parentID The ID of the new parent domain of the domain that was created. 

data The new xml data string for the domain.

flags The new flags for the domain.

modifiedDate The new modification date of the domain (i.e., the date of this change). 

modifiedBy The new modified by user ID for the domain (i.e., the ID of the user who made this change). 

version The new version number of the domain. 

Domain deleted

Parent Property Child Property Description
domainId
The ID of the domain that was deleted.
oldDomain
name
The old name of the domain.

userspace
The old userspace of the domain.

reference
The old reference of the domain.

parentID
The ID of the old parent domain of the domain that was created.

data
The old xml data string for the domain.

flags
The old flags for the domain.

modifiedDate
The old modification date of the domain (i.e., the date of this change).

modifiedBy
The old modified by user ID for the domain (i.e., the ID of the user who made this change).

version
The old version number of the domain.

Course data Events

The following tables define the Properties you can use to filter the data returned for each course Event.

Course created

Parent Property Child Property Description
courseId
The ID of the course that was created.
newCourse title The title of the new course.

domainId The ID of the domain for the new course.

reference The reference of the new course.

schema The schema of the new course.

baseId The ID of the base course of the new course. 

type The type for the new course.

startDate The start date of the new course.

endDate The end date of the new course.

days The days for the new course.

term The term for the new course.

data The xml data string for the new course.

flags The flags for the new course.

modifiedDate The modification date of the new course (i.e., the date of this change). 

modifiedBy The modified by user ID for the new course (i.e., the ID of the user who made this change). 

version The version number of the new course. 

Course changed

Parent Property Child Property Description
courseId
The ID of the course that was changed.
oldCourse title The old title of the course.

domainId
The ID of the old domain for the course.

reference
The old reference of the course.

schema
The old schema of the course.

baseId
The ID of the old base course of the course.

type
The old type for the course.

startDate
The old start date of the course.

endDate
The old end date of the course.

days
The old days for the course.

term
The old term for the course.

data
The old xml data string for the course.

flags
The old flags for the course.

modifiedDate
The old modification date of the course (i.e., the date of this change).

modifiedBy
The old modified by user ID for the course (i.e., the ID of the user who made this change).

version
The old version number of the course.
newCourse title The new title of the course.

domainId The ID of the new domain for the course.

reference The new reference of the course.

schema The new schema of the course.

baseId The ID of the new base course of the course. 

type The new type for the course.

startDate The new start date of the course.

endDate The new end date of the course.

days The new days for the course.

term The new term for the course.

data The new xml data string for the course.

flags The new flags for the course.

modifiedDate The new modification date of the course (i.e., the date of this change).

modifiedBy The new modified by user ID for the course (i.e., the ID of the user who made this change).

version The new version number of the course.

Course deleted

Parent Property Child Property Description
courseId
The ID of the course that was deleted.
oldCourse title The old title of the course.

domainId
The ID of the old domain for the course.

reference
The old reference of the course.

schema
The old schema of the course.

baseId
The ID of the old base course of the course.

type
The old type for the course.

startDate
The old start date of the course.

endDate
The old end date of the course.

days
The old days for the course.

term
The old term for the course.

data
The old xml data string for the course.

flags
The old flags for the course.

modifiedDate
The old modification date of the course (i.e., the date of this change).

modifiedBy
The old modified by user ID for the course (i.e., the ID of the user who made this change).

version
The old version number of the course.

User data Events

The following tables define the Properties you can use to filter the data returned for each user Event.

User created

Parent Property Child Property Description
UserId
The ID of the user that was created.
newUser firstName The new first name of the user.

lastName The new last name of the user.

reference The new reference of the user.

domainId The ID of the domain where the new user was created.

email The new email for the user. 

flags The new flags for the user.

modifiedDate The new modification date of the user (i.e., the date of this change). 

modifiedBy The new modified by user ID for the user (i.e., the ID of the user who made this change). 

version The version number of the new user. 

User changed

Parent Property Child Property Description
UserId
The ID of the user that was changed.
oldUser firstName
The old first name of the user.

lastName
The old last name of the user.

reference
The old reference of the user.

domainId
The ID of the old domain of the user that was changed.

email
The old email for the user.

flags
The old flags for the user.

modifiedDate
The old modification date of the user (i.e., the date of this change).

modifiedBy
The old modified by user ID for the user (i.e., the ID of the user who made this change).

version
The old version number of the user.
newUser firstName The new first name of the user.

lastName The new last name of the user.

reference The new reference of the user.

domainId The ID of the new domain of the user that was changed.

email The new email for the user. 

flags The new flags for the user.

modifiedDate The new modification date of the user (i.e., the date of this change). 

modifiedBy The new modified by user ID for the user (i.e., the ID of the user who made this change). 

version The new version number of the user. 

User deleted

Parent Property Child Property Description
UserId
The ID of the user that was deleted.
oldUser firstName
The old first name of the user.

lastName
The old last name of the user.

reference
The old reference of the user.

domainId
The ID of the old domain of the user that was changed.

email
The old email for the user.

flags
The old flags for the user.

modifiedDate
The old modification date of the user (i.e., the date of this change).

modifiedBy
The old modified by user ID for the user (i.e., the ID of the user who made this change).

version
The old version number of the user.

Enrollment data Events

The following tables define the Properties you can use to filter the data returned for each enrollment Event.

Enrollment created

Parent Property Child Property Description
enrollmentId
The ID of the enrollment that was created.
newEnrollment userId The new ID of the user being enrolled.

courseId The ID of the new course being enrolled in.

domainId
The ID of the new domain owning the enrollment.

reference The new reference of the enrollment.

guid The new GUID for the enrollment

privileges The new privileges for the enrollment. 

status The new status for the enrollment.

startDate The new start date for the enrollment.

endDate The new end date for the enrollment.

flags The new flags for the enrollment.

modifiedDate The new modification date of the enrollment (i.e., the date of this change). 

modifiedBy The new modified by user ID for the enrollment (i.e., the ID of the user who made this change). 

version The new version number of the enrollment. 

roleId The new role ID for the enrollment.

Enrollment changed

Parent Property Child Property Description
enrollmentId
The ID of the enrollment that was changed.
oldEnrollment userId
The old ID of the user being enrolled.

courseId
The ID of the old course owning the enrollment.

domainId
The ID of the old domain owning the enrollment.

reference
The old reference of the enrollment.

guid
The old GUID for the enrollment

privileges
The old privileges for the enrollment.

status
The old status for the enrollment.

startDate
The old start date for the enrollment.

endDate
The old end date for the enrollment.

flags
The old flags for the enrollment.

modifiedDate
The old modification date of the enrollment (i.e., the date of this change).

modifiedBy
The old modified by user ID for the enrollment (i.e., the ID of the user who made this change).

version
The old version number of the enrollment.

roleId
The old role ID for the enrollment.
newEnrollment userId The new ID of the user being enrolled.

courseId The ID of the new course owning the enrollment.

domainId
The ID of the new domain owning the enrollment.

reference The new reference of the enrollment.

guid The new GUID for the enrollment

privileges The new privileges for the enrollment. 

status The new status for the enrollment.

startDate The new start date for the enrollment.

endDate The new end date for the enrollment.

flags The new flags for the enrollment.

modifiedDate The new modification date of the enrollment (i.e., the date of this change). 

modifiedBy The new modified by user ID for the enrollment (i.e., the ID of the user who made this change). 

version The new version number of the enrollment. 

roleId The new role ID for the enrollment.

Enrollment deleted

Parent Property Child Property Description
enrollmentId
The ID of the enrollment that was changed.
oldEnrollment userId
The old ID of the user being enrolled.

courseId
The ID of the old course owning the enrollment.

domainId
The ID of the old domain owning the enrollment.

reference
The old reference of the enrollment.

guid
The old GUID for the enrollment

privileges
The old privileges for the enrollment.

status
The old status for the enrollment.

startDate
The old start date for the enrollment.

endDate
The old end date for the enrollment.

flags
The old flags for the enrollment.

modifiedDate
The old modification date of the enrollment (i.e., the date of this change).

modifiedBy
The old modified by user ID for the enrollment (i.e., the ID of the user who made this change).

version
The old version number of the enrollment.

roleId
The old role ID for the enrollment.
forum

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