Data Checks

⏵ Home ⏵ Join The Aitum Discord ⏵ Getting Started ⏵ FAQ

Data Checks

Add data lookups into your rules using data checks

🚧

NOTICE: We are currently in the process of a full rewrite of our Aitum App Documentation. The information on this page may be incomplete or outdated. Thank you for your patience as we work to bring you a fully updated and thorough set of documentation.

Data Checks allow you to lookup data and information from a range of sources. The result of these data lookups are exposed as local variables and can be used later in your rule, in both subsequent checks and actions.

How do I use data checks?

When creating a rule, you can add a new data check by clicking the New Data Check button. Then select the type of data check you'd like to use, and fill in any required information for it.

The Get Current Scene Data Check will provide you with a local variable of your OBS studio’s current scene!

After you've added a data check, you can use the resulting local variables in subsequent checks and actions.

💡

In the example above, we are storing the current scene to a Text Global Variable called “OBS Scene”. We can do this BEFORE an automation that will change scenes in OBS, when the automation is completed, we can return to the previous scene that we stored by using the global variable “OBS Scene”.

This is a great way to allow a channel point redeem to change scenes temporarily, then return to the scene you were on when the channel point redeem started.

Data Check Types

There are three major categories of Data Checks in Aitum at the moment, Twitch, Aitum, and OBS. Each of these have multiple Data Check types as listed below:

Twitch: Get User Info

Get User Info allows you to retrieve information about a Twitch user. The following local variables will be available in your rule when using the Get User Info data check:

Get User Info: Display Name - Users Display Name
Get User Info: Profile Picture - Profile Picture URL
Get User Info: Is Subscriber - Sub Status
Get User Info: Subscription Tier - Sub Tier (1/2/3)
Get User Info: Is Moderator - Moderator Status
Get User Info: Is VIP - VIP Status
Get User Info: Is Follower - Follower Status
Get User Info: Bits Donated - Total Bits Donated
Get User Info: Bits Leaderboard - Bit Donation Ranking

One powerful example is to use the Get User Info Data Check when the trigger of the rule is from the Twitch device, such as Channel Point Redemption. Then set the Username field to be the Twitch: Username local variable.

This will provide the rule with local variables containing extra data about the user who triggered the Channel Point Redemption. We can then use an if/else action type to check whether or not the user is a Moderator.

Twitch: Get Current Stream Stats

Allows you to retrieve information about your current stream. Requires you to be streaming live on Twitch.

Exposes the following variables:

Uptime - How long you have been streaming
Title - The title of your stream
Viewers - How many viewers are watching your stream
Category - The category you are currently streaming in
Subscribers - Returns the current subscriber count for your Twitch channel