Skip to main content

Intro

Twitch is a live streaming video platform that focuses on video gaming, including playthroughs of video games, broadcasts of eSports competitions, creative content, and music broadcasts. To learn more about the Twitch API, visit their page (https://dev.Twitch/ ). You connect to your Twitch account in the Data Center. This topic discusses the fields and menus that are specific to the Twitch connector user interface. General information for adding DataSets, setting update schedules, and editing DataSet information is discussed in Adding a DataSet Using a Data Connector.

Prerequisites

To connect to your Twitch account and create a DataSet, you must have the username and password for your Twitch account.

Connecting to Your Twitch Account

This section enumerates the options in the Credentials and Details panes in the Twitch Connector page. The components of the other panes in this page, Scheduling and Name & Describe Your DataSet, are universal across most connector types and are discussed in greater length in Adding a DataSet Using a Data Connector.

Credentials Pane

The Domo Twitch connector uses OAuth to connect, so there is no need to enter credentials within Domo. Click Connect (or select Add Account if you have existing Twitch accounts in Domo) to open the Twitch OAuth screen where you can enter your Twitch username and password. Once you have entered valid Twitch credentials, you can use the same account any time you go to create a new Twitch DataSet. You can manage connector accounts in the Accounts tab in the Data Center. For more information about this tab, see Managing User Accounts for Connectors.
Note: If you are already logged into Twitch when you connect in Domo, you are authenticated automatically when you click Add account. If you want to connect to an account that is different from the one you are logged into, you must first log out of Twitch.

Details Pane

This pane contains a primary Reports menu, along with various other menus which may or may not appear depending on the report type you select.

Menu

Description

Report

Select the Twitch report you want to run. The following reports are available:

Report Name Description

Active Teams(Deprecated)

Gets a list of all active teams.

All Streams(Deprecated)

Gets a list of all live streams.

Banned Event

Retrieves all user bans and un-bans in a channel.

Banned User

Retrieves all banned and timed-out users in a channel.

Bits Leader Board

Retrieves a ranked list of Bits leaderboard information for an authorized broadcaster.

Broadcaster Subscriptions

Retrieves all of a broadcaster’s subscriptions.

Channel Information

Retrieves channel information for users.

Channel Follows(Deprecated)

Gets a list of users who follow a specified channel.

Channel Streams(Deprecated)

Gets stream information for a specified user.

Cheermotes

Retrieves the list of available Cheermotes, animated emotes to which viewers can assign Bits, to cheer in chat.

Clips

Retrieves clip information by clip ID (one or more), broadcaster ID (one only), or game ID (one only).

Code Status

Retrieves the status of one or more provided codes.

Current Streams Summary(Deprecated)

Gets a summary of live streams.

Extension Analytics

Retrieves a URL that extension developers can use to download analytics reports (CSV files) for their extensions. The URL is valid for 5 minutes.

Extension Transactions

Retrieves a list of transactions that have occur for their extension across all of Twitch.

Followed Streams(Deprecated)

Gets a list of online streams a user follows.

Game Analytics

Retrieves a URL that game developers can use to download analytics reports (CSV files) for their games. The URL is valid for 5 minutes.

Games

Retrieves game information by game ID or name.

Get Specific Channel(Deprecated)

Gets a list of specified channel details.

Hype Train Events

Retrieves the information of the most recent Hype Train of the given channel ID. When there is currently an active Hype Train, it returns information about that Hype Train.

Moderator Events

Retrieves a list of moderators or users added and removed as moderators from a channel.

Moderators

Retrieves all moderators in a channel.

Search Channels

Retrieves a list of channels (users who have streamed within the past 6 months) that match the query via channel name or description either entirely or partially. Results include both live and offline channel.

Stream Markers

Retrieves a list of markers for either a specified user’s most recent stream.

Search Streams(Deprecated)

Searches for streams based on a specified search query. A list of streams is returned if the search query parameter is matched entirely or partially, in the channel description or in the game name.

Stream Tags

Retrieves the list of all stream tags defined by Twitch, optionally filtered by tag ID(s).

Streams

Retrieves information about active streams. Streams are returned sorted by the number of current viewers, in descending order.

Top Games

Retrieves games sorted by the number of current viewers on Twitch, most popular first.

Users

Retrieves information about one or more specified Twitch users. Users are identified by optional user IDs and/or login name. If neither a user ID nor a login name is specified, the user is looked up by Bearer token.

User’s Channels(Deprecated)

Get a list of all User’s Channels.

Users Follow

Retrieves information on follow relationships between two Twitch users. At a minimum, from_id or to_id must be provided for a query to be valid.

User Extensions

Retrieves a list of all extensions (both active and inactive) for a specified user, identified by a Bearer token.

Videos

Retrieves video information by game ID (one only), user ID (one only) or video ID(up to 100).

Username

Enter the username of the user you want to retrieve information for.

Channel Name

Enter the name of the video channel you want to retrieve information for.

Search Query

Enter the query you want to return results for.

Period

Select the timeframe for the report.

User’s Channel

Returns a list of all of your channels.

Videos

Returns a list of VODs (Videos on Demand) for a specified channel.

Other Panes

For information about the remaining sections of the connector interface, including how to configure scheduling, retry, and update options, see Adding a DataSet Using a Data Connector.