SCALAR
Int
The Int
scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
link GraphQL Schema definition
1 scalar Int
link Required by
- AdPropertiesAd Properties is an object that defines ad properties for a channel.
- AdRequestContextThe context of an upcoming ad request.
- AdSessionAdSession is the response object from an Ad Request.
- AdSlotDefines ads management attributes for channel.
- AggregatedReferralsGrouping of referral sources with name and count -- e.g. ("UK", 1437).
- AssignEmoteToBitsTierInputThe input for assign emote to bits tier.
- AutoModConfigurationDefines all AutoMod level settings for a channel, either may be not be set.
- AutoModContentInputAutoModContentInput is the input of query AutoModContent.
- AutoModFailureReasonAutoModFailureReason is the failure reason from AutoMod.
- AutoModProperties
- AutoModTopicAn auto moderation topic with value.
- AutoRefillProfileAuto Refill profile information.
- BalanceBalance for a Twitch User Account in a FIAT currency. Can be used to purchase product on the Twitch Platform.
- BanUserFromChatRoomError
- BeginUseBitsInExtensionPayloadThe result of a BeginUseBitsInExtension mutation.
- BitsAdOfferBitsAdOffer is an offer to earn bits by watching an ad or interacting with an engagement.
- BitsBadgeTierBits Badges with their associated settings.
- BitsBadgeTierInputBadgeTier metadata to modify.
- BitsBadgeTierNotificationA notification about achieving a new bits badge tier. Used to send a special message.
- BitsBundleOfferBitsBundleOffer is an offer to purchase a number of bits for a certain price.
- BitsChallengeConditionPoolRecipientWeightedShareBitsChallengeConditionPoolRecipientWeightedShare represents the weighted share of the total bits pool that a recipient user is entitled to upon condition satisfaction.
- BitsEventAn event that captures a single bits transaction.
- BitsEventConnectionA paginated list of bits events, and its metadata.
- BitsLeaderboardBitsLeaderboard contains the leaderboard for a specified channel.
- BitsLeaderboardEntryLeaderboard entry at a specific node in a leaderboard connection.
- BitsLeaderboardItemLeaderboard item at a specific node in a leaderboard connection.
- BitsLeaderboardItemConnectionBits leaderboard connection is used to show the various leaderboard items.
- BitsOfferBitsOffer is a way to obtain more bits.
- BitsProductA product for bits that contains all information about a product, except for the pricing.
- BitsProductSelfEdgeThe relation of a Bits product to a user.
- BountyA bounty is a task that a user can complete for a payout.
- BountyCampaignA campaign defines the requirements and parameters for a set of bounties.
- BountyCampaignBrandDetailsDetails about a bounty campaign that only the sponsoring brand should see.
- BountyCampaignPerformanceMetricMetric containing details about how a campaign performed over a time period.
- BountyCampaignReportingDetails about a bounty campaign reporting that only the sponsoring brand should see.
- BountyChatCTAA chat Call to Action (CTA) that will be trigger in the broadcaster chat while doing the bounty.
- BountyRestrictionDefines the restrictions that are placed on a bounty.
- CampaignObjectiveThis type holds information about a campaign objective, which belongs to a campaign. An objective can hold multiple milestones which users can hit and get rewards. An objective can hold a cheer group.
- CampaignTriggerThis type holds information about a campaign trigger, which belongs to a campaign. A trigger has a list of rewards that can be earned by various one time events.
- CelebrationCelebration is a configuration that denotes when a celebration is triggerd and when sort of celebration will show when it triggers.
- ChallengeConditionParticipantSummaryA summary of participants attached to a particular condition in a particular state.
- ChallengeConditionParticipantSummaryByStateA summary of condition participants attached to a particular condition, grouped by state.
- ChallengeUseBitsEffectDetailsDetails of the UseBits effect.
- ChallengeUseBitsEffectSummaryA summary of USE_BITS effects attached to a particular condition in a particular state.
- ChallengeUseBitsPoolRecipientWeightedShareChallengeUseBitsPoolRecipientWeightedShare represents the weighted share of the total bits pool that a recipient user is entitled to upon condition satisfaction.
- ChangelogEntryChangelogEntry is an entry that displays new items and notifications in the creator homepage changelog.
- ChannelA User's place on Twitch.
- ChannelChallengeA challenge to which users can contribute bits.
- ChannelChallengeParticipantA participant contributing to a challenge and associated information.
- ChannelClipsCreationAuthRestrictionOptionsInputChannelClipsCreationAuthRestrictionOptionsInput are the additional options for the auth restrictions.
- ChannelClipsCreationRestrictionOptionsChannelClipsCreationRestrictionOptions are the additional options for the auth restrictions.
- ChannelDashboardViewOptionsDetails about the specific data of a layout type for a channel, such as the number of custom layouts available for use by the current user.
- ChannelHomeShelvesThe shelves that are shown on a channel's home page.
- ChannelModerationActionOnChannelEntryModeration Actions relating to another channel. ex: host, unhost, raid, unraid.
- ChannelModerationActionOnChatModeEntryModeration Actions realting to chat modes. ex: slow on, followers only on, emotes only, sub only, clear chat.
- ChannelModerationActionOnUserEntryModeration Actions relating to a user. ex: ban, unban, timeout, untimeout, mod, unmod, vip, unvip.
- ChannelSelfEdgeInformation about the requesting user with respect to a channel.
- ChargeModelPlanIntervalChargeModelPlanInterval is the time interval for the charge model.
- ChatRoomBanStatus
- ChatSettingsChatSettings are settings and rules for chatting in a channel.
- ChattersInfoInformation about the active chatters on a channel.
- CheckoutConfigurationConfigs that help initiate the bits checkout flow.
- CheckoutConfigurationInputInputs for checkoutConfiguration.
- CheckoutPriceSummaryPrice information about an item in the checkout process.
- CheerInfoCheerInfo is the channel-specific bits/cheer settings and current state.
- CheermoteCampaignA campaign that is in association with a cheermote. Like, Old Spice could have a cheermote with Terry Crew's head that they will sponsor X Bits that get added on to cheers that use their cheermote.
- CheermoteCampaignSelfEdgeEdge that relates a cheermote campaign to the logged in user.
- CheermoteCampaignThresholdThreshold for sponsored cheermote campaign matching.
- CheermoteColorConfigThe color that should be used to display each cheer amount.
- CheermoteTierCheermoteTier has information about a single tier of a cheermote.
- CheermoteTokenCheermoteToken is used to render a cheermote in a message.
- CheerPartnerChatMessageSettingsBits partner settings associated with the chat message.
- CheerPartnerRecentCheerSettingsBits partner settings associated with recent cheers.
- CheerSettingsCheerSettings are the channel-specific cheer settings.
- ClaimCommunityPointsPayloadThe response from claiming community points.
- ClipA recorded, replayable part of a live broadcast.
- ClipRawMediaClipRawMedia describes metadata about the clip's raw media used in clip editing.
- CloudBroadcastProviderCapabilitiesCapabilities of a cloud broadcast provider.
- CollectionCollection (a.k.a. Playlist) is a backend concept for a list of videos.
- CollectionConnectionA paginated list of videos, and its metadata.
- CommunityPointsAutomaticRewardAn automatic community points reward.
- CommunityPointsChannelEarningSettingsInformation on how points are earned by viewers in a specific channel.
- CommunityPointsChannelSettingsSettings for a channel's Community Points.
- CommunityPointsClaimPoints that are available for a user to click to claim in a channel.
- CommunityPointsCommunityGoalCommunity goal.
- CommunityPointsCommunityGoalContributionCommunity goal contribution.
- CommunityPointsCustomRewardA custom community points reward on a channel.
- CommunityPointsCustomRewardGlobalCooldownSettingSettings for how often a custom reward may be redeemed per stream.
- CommunityPointsCustomRewardGlobalCooldownSettingInputInput for creating and updating a Community Points custom reward's max per stream settings.
- CommunityPointsCustomRewardMaxPerStreamSettingSettings for how often a custom reward may be redeemed per stream.
- CommunityPointsCustomRewardMaxPerStreamSettingInputInput for creating and updating a Community Points custom reward's max per stream settings.
- CommunityPointsCustomRewardMaxPerUserPerStreamSettingSettings for how often a custom reward may be redeemed per stream.
- CommunityPointsCustomRewardMaxPerUserPerStreamSettingInputInput for creating and updating a Community Points custom reward's max per stream settings.
- CommunityPointsCustomRewardTemplateA template used to create a custom reward.
- CommunityPointsCustomRewardUserRedemptionCustom reward user redemption.
- CommunityPointsPropertiesProperties relating to a user's community points in a channel.
- CommunityPointsRewardSummaryA summary of information about redemptions of a given custom community points reward. Only returns results for logged-in, authorized users, otherwise returns a nil response.
- CommunityPointsUpdateCustomRewardRedemptionStatusesProgressThe type representing Community Points Update Custom Reward Redemption Statuses Progress.
- CommunityPointsWatchStreakEarningSettingsSettings for how many community points are awarded for a watch streak of a specific duration.
- CompanyA company that is on Twitch.
- CompetitionA Competition created by a competition organizer.
- CompetitionLobbyA Lobby in a phase.
- CompetitionLobbyParticipantA CompetitionLobbyParticipant, and its scores, in a lobby.
- CompetitionParticipantConnectionSorted list of competition participants.
- CompetitionPlacementThe placement within the competition for an participant.
- CompetitionPlayerA player is solo participant in a Competition.
- CompetitionPlayerConnectionPaginated list of players in a Competition.
- CompetitionStandingA single participant's competition standing including score and placement.
- CompetitionTeamA Team is scheduled or has competed in a Competition.
- CompetitionTeamConnectionList of competition teams and their scores.
- ComponentActivationInputThe required configuration to activate a component extension.
- ComponentViewThe view configuration of an extension if the component anchor is supported.
- ComponentViewInputThe view configuration of an extension if the component anchor is supported.
- ContributeCommunityPointsCommunityGoalInputContribute community goal input.
- ContributeToChallengeInputInputs for contributing to a challenge.
- CreateBitsChallengeConditionParticipantForExtensionInputCreateBitsChallengeConditionParticipantForExtensionInput creates a Bits condition participant on behalf of a user by an extension.
- CreateBountyCampaignInputCreateBountyCampaignInput includes the campaign that is being created.
- CreateCelebrationInputInputs for creating a new celebration.
- CreateCommunityPointsCommunityGoalInputCreate community goal input.
- CreateCommunityPointsCustomRewardErrorAn error from creating a custom Community Points reward in a channel.
- CreateCommunityPointsCustomRewardInputInput for creating a custom Community Points reward in a channel.
- CreateCompetitionInputCreate a Competition.
- CreateCompetitionLeaderboardDetailsInputThe required inputs for leaderboard format.
- CreateDropBenefitInputCreateDropBenefitInput has fields required to create a drop benefit.
- CreateExtensionImageUploadInfoErrorCreateExtensionImageUploadInfoError is wrapper for error associated with the createExtensionImageUploadInfo mutation.
- CreateExtensionImageUploadInfoInputInformation needed to generate a URL and UploadId to upload extension images to.
- CreateLoyaltyBadgeInputCreateLoyaltyBadge creates a new badge with these settings.
- CreateLoyaltyBadgeUploadConfigInputCreateLoyaltyBadgeUploadConfig creates a config with URL to upload the badge image to.
- CreatePanelImageUploadInfoInputInformation required to generate a URL to upload a panel image to.
- CreatePollInputInputs for creating a new poll.
- CreatePostPayload
- CreatePredictionEventErrorAn error returned from the createPredictionEvent mutation.
- CreatePredictionEventInputInput for creating a Prediction Event.
- CreateRoomError
- CreateScheduleSegmentErrorCreateScheduleSegmentError is a wrapper for error associated with the CreateScheduleSegment mutation.
- CreateScheduleSegmentInputThe input to create a new schedule segment.
- CreateStuccoPackItemInputSingle item in a stuccopack, as part of the create stucco pack call, representing one stucco to be used in a certain slot.
- CreateVideoCommentInput
- CreateVideoHighlightInput
- CreateVideoThumbnailUploadRequestInputInput to CreateVideoThumbnailUploadRequest mutation.
- CreatorCampArticleA CreatorCampArticle is a represenation of an article from https://www.twitch.tv/creatorcamp.
- CreatorGiftingThe container for creator gifts the creator has. This will be null if the creator does not have this feature enabled.
- CreatorReferralLinkStatContains a reference to the link object and the number of referrals from that link.
- CreatorReferralSummaryContains the statistics summary for creator referral link.
- CreatorReferralSummaryDayEach data point contains date and list of links with number of referred users.
- CreatorTimeseriesItemSingle item of stats for the time series.
- CreatorTimeseriesMetricList of timestamp, value metric pairs and total for that metric.
- CreditChargeModelCreditChargeModel defines a charge model using non-FIAT currencies.
- CurrentPrimePayoutCurrentPrimePayout is the detail breakdown of the payout that will be made in this specific payout cycle.
- DashboardActivityFeedActivityAutoHostingWhen a user AutoHosts a channel.
- DashboardActivityFeedActivityBitsUsageWhen a user uses Bits for or sends Bits to a channel.
- DashboardActivityFeedActivityBoostCompleteWhen a Boost completes for the given user.
- DashboardActivityFeedActivityBoostStartWhen a Boost starts for the given user.
- DashboardActivityFeedActivityCommunitySubscriptionGiftingWhen a user gifts subscriptions to a community for a channel.
- DashboardActivityFeedActivityCopoGoalEndWhen a Community Goal ends for the channel.
- DashboardActivityFeedActivityHostingWhen a user hosts a channel.
- DashboardActivityFeedActivityHypeTrainEventWhen a HypeTrain event occurs for the given user.
- DashboardActivityFeedActivityIndividualSubscriptionGiftingWhen a user gifts a single subscription to another individual user for a channel.
- DashboardActivityFeedActivityPrimeResubscribingWhen a user resubscribes via Twitch Prime to a channel.
- DashboardActivityFeedActivityRaidingWhen a user raids a channel.
- DashboardActivityFeedActivityResubscribingWhen a user resubscribes (NOT via Twitch Prime) to a channel.
- DashboardActivityFeedActivitySubscribingWhen a user subscribes for the first time (NOT via Twitch Prime) to a channel.
- DeferredPrimePayoutDeferredPrimePayout is the earning that has been deferred to future payout cycles.
- DeleteBitsBadgeTierEmoticonInputThe input for delete bits badge tier emoticon.
- DeleteClipsPayloadDeleteClipsPayload returns the deleted clips. Only the slug and id can be accessed from the returned list of deleted clips.
- DensityDefines ads management attributes for channel.
- DetailedAutoModConfigurationDefines AutoMod category levels for a Channel.
- DetailedAutoModLevelsInputDefines AutoMod category levels for a Channel.
- DirectoryA Directory is a container of content – Streams, Videos, and Clips – on Twitch.
- DisablePrerollsAbilityDisable Prerolls Ability contains the properties used by the Disable Prerolls Feature.
- DisablePrerollsFreeTimeDisable Prerolls Free Time maps the relationship between a specific midroll length and amount of preroll-free time earned for a channel.
- DiscountBreakdownDiscountBreakdown shows discounted pricing for a promotional offer.
- DropActionContains all of the information about a Drop's action stating what happens when a drop is triggered. //To be deprecated.
- DropBenefitContains all of the information about a Drop awarded to a user.
- DropBenefitEdgeThe DropBenefitEdge links a drop with a benefit and describes how many times that benefit can be granted by this drop. A benefit can be granted multiple times by event based drops. For example, a benefit could be granted every time the broadcaster gets a kill streak, up to 3 times.
- DropCurrentSessionThe drop that is closest to completing for the current user that is actively earning progress.
- DropEligibilityContains all of the information about a Drop awarded to a user.
- EmbeddedEmoteEmbeddedEmote is an encoding format used to describe an emote embedded in a string of text. Example: body = "hey KappaHD" from = 4 to = 10 "KappaHD" will be replaced with the KappaHD emote image.
- Emote
- EmoteBitsBadgeTierSummaryBits Badges Tier metadata for emotes.
- EmoteBitsBadgeTierSummarySelfEdgeThe Bits Badge Tier Summary data that is user-dependent.
- EmoteOrderThe new order for the specified emote in a particular emote group.
- EndUseBitsInExtensionPayloadThe result of a EndUseBitsInExtension mutation.
- EpisodeDetailsEpisode metadata.
- EventBasedDropDrop triggered by an in-game event.
- ExperimentExperimental properties that should NOT be used outside of experiments. When your property is no longer in use, please mark as deprecated and then formally delete it.
- ExtensionTwitch Extension.
- ExtensionActivationConfigThe current activation configuration for an installed extension.
- ExtensionCategoryAn extension category.
- ExtensionCategoryConnectionA paginated list of extension categories, and their metadata.
- ExtensionConnectionA paginated list of extensions, and its metadata.
- FeaturedItem
- FeaturedStreamFeaturedStream contains extra metadata for presenting a featured Stream.
- FeaturedVideoDEPRECATED: do not use, it is subject to change. FeaturedVideo contains extra metadata for presenting a featured video.
- FeedFeed is twitch's pulse product of content a user may enjoy.
- FeedItemTrackingFeedItemTracking contains the tracking info of a feeditem.
- FlaggedTrackInformation about the flagged track of copyrighted music.
- FollowConnectionA paginated list of follows relationships.
- FollowerConnectionA paginated list of followers relationships.
- FriendConnectionA list of a user's friend relationships.
- GameA Game is often the subject of a Stream on Twitch.
- GoLiveNotificationAnalytics associated with a given notification.
- GoLiveNotificationTimeseriesAnalytics associated with go live notification timeseries.
- GoLiveNotificationTimeseriesItemSingle go live notification timeseries item. Represents day, or week/monthly aggregation.
- HeroAssetPositionRepresents the position of an asset relative to a skeleton.
- HighlightRangeInput to describe a single continuous time range of the source VOD to be included in the highlight.
- HostConnectionPaginated list of Users hosting a particular target User.
- HypeTrainConfigThe Hype Train config for a channel.
- HypeTrainKickoffConfigThe Hype Train kickoff configuration.
- HypeTrainKickoffInputHypeTrainKickoffInput specifies settings for kicking off hype trains.
- HypeTrainLevelThe Hype Train level configuration, which includes information about level completion and associated rewards.
- HypeTrainNotificationThresholdThe notification threshold for an action / source combination.
- HypeTrainParticipationThe Hype Train participation structure that contains relevant information about the participation event.
- HypeTrainParticipationConversionRateThe participation conversion rate for what an action will count towards the Hype Train.
- HypeTrainProgressThe structure that contains relevant information about the current progress in the Hype Train.
- Image
- ImageOptions
- IncomingFriendRequestConnectionFriend requests sent from other users to this user.
- IngestSessionIngestSession is a set of stream metadata related to ingest events.
- IntegerTokenA shelf title token type that contains a number with various formatters.
- InternalChargeModelSelfEdgeThe authenticated user's relationship with the internal charge model.
- InterruptScheduleBoundsErrorInterruptScheduleBoundsError represents errors that are due to input being out of bounds.
- KeyBatchConnectionThe connection of key batches for a given key pool.
- KeyBatchNodeThe information associated with a given key batch.
- KeyPoolConnectionThe connection of key pools to a user.
- LeaderboardDetailsThe details of Leaderboard format.
- LinkOEmbedLinkOEmbed is a link oEmbed. This looks strange being empty, but mirrors the oEmbed official spec most exactly.
- LoyaltyBadgeCommunicates a Loyalty Badge (usually during upload).
- LWATokenCaller should store all of these fields.
- MakePredictionErrorAn error returned from the makePrediction mutation.
- MakePredictionInputInput for making a Prediction.
- ManualChannelChallengeA custom challenge created by the broadcaster.
- ManualTriggerBasedDropDrop manually triggered.
- MessageReplyConnectionA list of messages.
- MilestoneMilestone is a construct is used within a tournament. For a given threshold, when the user cheers at or past this amount, they are able to claim a reward for cheering at this level. Rewards can be fulfilled by different platforms. Types of milestones: - **Global milestone**: for a given threshold, this milestone is reached when cheers from all users on the channel is greater than or equal to the threshold. This unlocks a reward for all users who have cheered. - **Individual milestone**: for a given threshold, this milestone is reached when an individual user's total cheers in the channel is greater than or equal to the threshold. This unlocks a reward for the individual user who cheered. - **Team milestone**: for a given threshold, this milestone is reached when an individual cheers for a specific team in total is greater than or equal to the threshold. This unlocks a reward for the individual user who cheered. NOTE: Should have been named CheeringTournamentMilestone.
- ModerationLogsAn interface to query subsets of the moderation logs information for a given channel.
- ModLogsAn interface to query subsets of the moderation logs information for a given channel.
- ModLogsMessageConnectionPaginated list of messages from a single sender in a channel.
- ModLogsTargetedModActionsConnectionPaginated list of mod logs of a user on a channel.
- ModViewNewsfeedEntryModViewNewsfeedEntry is an entry that displays content for the Mod View page's "What's New" feed.
- MovieDetailsMovie metadata.
- MultiplayerAdOfferA multiplayer ad offer is an ad offer.
- OEmbedOEmbed is a universal spec converted to GraphQL from http://oembed.com/.
- OfferEligibilityOfferEligibility describes user's eligibility to purchase an Offer.
- OfferPromotionPromotion is a modifier to an Offer.
- OfferSelfEdgeThe authenticated user's relationship with the offer.
- OnboardingCurrent state of the user in the onboarding process.
- OnsiteNotificationsSummary
- OnsiteNotificationsUnreadSummaryContains summary for unread infomation.
- OrganizationA developer organization.
- OrganizationInviteConnectionPaginated list of organization invites in an organization.
- OrganizationInviteUserConnectionPaginated list of organization invites for in a user.
- OrganizationMemberConnectionA paginated list of organization member relationships.
- OutgoingFriendRequestConnectionFriend requests sent from this user to other users.
- PanelViewPanelView holds the view configuration of an extension if the panel anchor is supported.
- PanelViewInputPanelViewInput holds the view configuration of an extension if the panel anchor is supported.
- PaymentMethodType of payment method a user has used to buy products on Twitch, such as subs.
- PaymentTransactionThere are legacy and new data sources that contain similar payment transaction data. This type aims to merge several data sources into one to expose a consistent payment history for each Twitch user.
- PaymentTransactionConnectionA paginated list of payment transactions, and its metadata.
- PaymentTransactionProductPayment transaction purchased product details.
- PayoutBalancePayout Balance is the amount accrued by the user since their last Payout.
- PhotoOEmbed
- PollA poll users can vote in.
- PollChoiceA choice in a poll that users can vote for.
- PollSettingsBitsVotesBits votes poll settings.
- PollSettingsCommunityPointsVotesChannel Points votes poll settings.
- PollTokenBreakdownA breakdown of tokens used/by for this poll/choice/user.
- PollTopBitsContributorTop contributor to the poll and the bits they contributed.
- PollTopCommunityPointsContributorTop contributor to the poll and the community points they contributed.
- PollTopContributorTop contributor to the poll and the bits they contributed. Deprecated: use PollTopBitsContributor instead.
- PollVoteBreakdownA breakdown of votes cast for/by this poll/choice/user.
- PollVoteTokensInputThe tokens that are used on a vote.
- PredictionA single Prediction made by a user on a Prediction Event.
- PredictionEventAn Event that users can make Predictions on.
- PredictionOutcomeA single Outcome that users can choose in a Prediction Event.
- PremiereDEPRECATED.
- PremiereConnectionDEPRECATED. Paginated list of videos.
- PriceInfoGeneric Price Information that supports taxing and multi region pricing. LONG-TERM NOTE: using Int (32 bit) as a price field can cause issue when we sell products locally e.g. 2147483648 (2^31) Lao Att = 253132 USD cent Therefor, if we sell product which price more than $2500 in Laos currency. We will need to fix this.
- PrimeOfferPrime Digital Content Offers are displayed to users on Twitch via Offers in the top nav.
- PrimeOfferWithEligibilityRepresents a Prime Gaming content offer with the requesting user's eligibility information. These offers are displayed on the Crown menu on Twitch.tv.
- PrimePayoutDetailPrimePayoutDetail shows the detailed breakdown of the prime payouts for a given user.
- PrimeVideoRatingContains rating information for Prime Video content.
- ProcessAndroidPaymentInputProcessAndroidPaymentInput contains the necessary fields to process an Android payment.
- ProcessIOSPaymentInputProcessIOSPaymentInput contains the necessary fields to process a payment from the iOS platform.
- PUBGMomentDetailsMoment Details specific to the PUBG game.
- PurchaseOfferInputPurchaseOfferInput contains the necessary fields to purchase an offer.
- PurchaseProfilePurchase profile of a recurring or non-recurring subscription that a user bought.
- QueryRoot fields to access the Twitch API.
- QuestEvaluationIntervalInterval that a quest is being evaluated for.
- QuestGoalIntProgress towards a particular quest goal.
- RadioTwitch Radio access.
- RadioContentPromotionA Twitch Radio LinkFire Input Response for Content Promotion.
- RadioTrackA Twitch Radio track.
- RaidA raid represents a broadcaster directing their viewers to another channel in a synchronized "raid" on the channel after a countdown during which each viewer has a chance to opt out of the raid. Raids are created by a broadcaster from their dashbboard where they can search and select the channel they wish to target. Once selected the raid takes counts down to prepare after which the broadcaster can tell the raid to "Go", redirecting all joined raiders to the target channel.
- RangeAn integer range with a minimum and a maximum.
- Reaction
- ReadNotificationsPayload
- Recommendations
- RecommendationsContextRecommendationsContext define parameters which can control recommendations logic. Clients should strive to fill in as many fields as possible for the highest quality recommendaitons. Many of these fields should be identical to what is sent in pageview events: https://blueprint.di.xarth.tv/#/schema/pageview.
- RecurringPaymentDetailPayment Method information for a recurring payment. An abstraction for a set of Payments models, existing here to surface to the Payments Management Page.
- RedeemCommunityPointsCustomRewardInputInput for redeeming a custom Community Points reward in a channel.
- RedeemCreatorGiftsInputRedeeemCreatorGiftsInput the input for redeeming subscriptions from a creator's balance.
- RedeemTrueXAdPayload
- ReorderCollectionItemInputReorderCollectionItemInput accepts a collectionID and item ID and parameters to update the item order of a collection.
- ResubNotificationA recent resub token to use for sending a special message.
- RevenueConfigRevenue configuration data related to a subscription product.
- RichOEmbed
- RoomDEPRECATED. A chatroom associated with a channel where members of the room can exchange messages.
- RoomModesModes that have been enabled for the room.
- RoomViewDEPRECATED A RoomView represents the authenticated user's self connection to a room, and includes the user's settings and permissions.
- RotateExtensionSecretsInputRotateExtensionSecretsInput includes the necessary parameters for creating a new extension secrets.
- RTMPSessionRTMPSession is metadata related to the RTMP data sent by the broadcaster.
- RunMultiplayerAdsInputInputs for running multiplayer ads.
- SaveComponentViewInputThe view configuration of an extension if the component anchor is supported.
- SavePanelViewInputPanelViewInput holds the view configuration of an extension if the panel anchor is supported.
- SCETitleSony Computer Entertainment (SCE) title properties. Used as part of stream metadata for PlayStation.
- ScheduleThe channel schedule.
- ScheduleSegmentThe segment of a schedule.
- ScheduleSegmentListInputThe inputs for the segmentList query.
- ScheduleSegmentOptionsThe optional parameters for scheduleSegment.
- SearchCategoriesConnectionContains categories search results.
- SearchForResultGamesContains game search results.
- SearchForResultRelatedLiveChannelsContains results for related live channels.
- SearchForResultUsersContains user search results.
- SearchForResultVideosContains video search results.
- SearchForTargetSpecify which index to run a user's search.
- SearchStreamConnectionList of users.
- SearchSuggestionCategoryA category search suggestion.
- SearchSuggestionChannelA channel search suggestion.
- SearchSuggestionHighlightA range that matches the search query.
- SearchTargetSpecify which index to run a user's search.
- SearchUserConnectionA list of user returned from forage by user query.
- SeasonDetailsSeason metadata.
- SeedCompetitionParticipantInputInputs for seeding a competition participant.
- SegmentStartTimeInputThe segment start time input.
- SendChatMessageThroughSubscriberModeInputInput for sending a chat message through subscriber-only mode with Channel Points.
- SendChatMessageThroughSubscriberModePayloadThe response from redeeming the skip subs only chat message reward.
- SendCheerInput
- SendExtensionMessageThrottleDataInformation about a rate limit throttle.
- SendHighlightedChatMessageInputInput for sending a highlighted chat message with Channel Points.
- SendHighlightedChatMessagePayloadThe response from redeeming the highlighted chat message reward.
- SendRoomMessageError
- SeriesDetailsSeries metadata.
- SetAutoAdDensityInputSets the auto ad density for the channel.
- SetAutoAdDensityPayloadShows the newly updated values for autoad settings.
- SetAutoRefillSettingsInputInput for setting auto refill settings.
- SetDropEventRuleInputSetDropEventRuleInput has the fields required to set an event based rule on a drop.
- SetDropManualTriggerRuleInputSetDropManualTriggerRuleInput has the fields required to set a manual trigger based rule on a drop.
- SetDropTimeBasedRuleInputSetDropTimeBasedRuleInput has fields required to update a drop's rule to a minutes watched based rule.
- SetSessionStatusPayload
- SetUnbanRequestsSettingsInputRequired input to set unban requests settings on a channel.
- ShortVideoReactionAn aggregated counter for the contained emote to display how many reactions to a ShortVideo there have been.
- SmartCostsAcknowledgementThe type representing Community Points Smart Costs Acknowledgements.
- SmartCostsAcknowledgementInputThe input representing Community Points Smart Costs Acknowledgements.
- SponsoredCheermoteChannelSettingsConnectionThe connection of sponsored cheermote channel settings to user.
- SquadStreamInvitationConnectionList of Squad Stream invitations.
- StartAdErrorStartAdError ...
- StartAdInputStartAdInput ...
- StartCloudBroadcastInputInput for remotely and asynchronously starting a cloud broadcast for the given channelID.
- StreamA live stream.
- StreamMetadataFilterInputQuery to let consumers filter streams that have specific metadata. e.g. return only those hearthstone streams that have broadcasterheroclass as mage. FE uses these parameters to implemtent filters.
- StreamSummaryAnalytics information for a streaming session.
- StuccoPackSlotA stucco pack slot represents a single ordered slot in a pack of stuccos.
- SubCountSeriesSub Count Series shows a user's sub counts broken down by type, tier, and date.
- SubCountSeriesDataPointA single data point in the time series.
- SubCountTierDataPointSubCountTierDataPoint shows the breakdown of subcount by tier.
- SubscribedChannelConnectionA list of channels subscribed to by a user.
- SubscriberBadgeProgressSubscriberBadgeProgress contains progress information for subscription badges based on a user's tenure.
- SubscriberCountBreakdownBreakdown of number of subscriptions by tier.
- SubscriberScoreInformation pertaining to user's subscriber score. Contains subscription count, sub points, emote limits, and information about the next subscriber level.
- SubscriberScoreBreakdownBreakdown of score by tier.
- SubscriptionBenefitData about a user's subscription to a broadcaster.
- SubscriptionCommunityGiftingAn Offer for purchasing community gift subscriptions with associated metadata about the Offer. Composes the "model" (Offer) with the "view" metadata about the offer.
- SubscriptionGiftOfferA gift offer that is available on a particular subscription based on gift type and platform.
- SubscriptionGiftPromotionThe promotion offer on a subscription gift offer.
- SubscriptionIntervalRepresents the interval of a subscription product.
- SubscriptionOfferSubscription pricing information.
- SubscriptionProductA subscription that is purchasable by users. Once purchased, the subscription entitles the user to use special emote sets on Twitch.
- SubscriptionProductSelfConnectionThe connection between the user and subscription product.
- SubscriptionPromotionThe promotion offer on subscription product.
- SubscriptionPurchaseDetailsThe receipt details for a subscription purchase.
- SubscriptionSummarySelfMost of the user specific fields for SubscriptionSummary.
- SubscriptionTenureTenure to a subscription product.
- SubscriptionTokenToken that a User uses for redeeming Subscriptions.
- SubscriptionTokenBundleProductA SubscriptionTokenBundleProduct can contain multiple Offers. ex) A Bundle of size 3 tokens, can have 3 other offers such as: - Normal offer: "Pay $16.99 for the bundle - Discounted, one-time buy offer: "Pay $14.99 for the bundle, but a one-time purchase only" - Bits: Use X amount of Bits to purchase this Bundle.
- SubscriptionTokenProductConfigDescribes configurable values for the token product line.
- TargetedModActionDetailsTargetedModerationAction is a ModLogs entry of a chat ban,timeout, or unban.
- TeamTeam represents a Twitch Team. Teams are collections of streaming channels, and are owned by a Twitch user. Teams have landing pages, e.g. https://www.twitch.tv/team/clg.
- ThumbnailOEmbed
- TimeBasedDropA drop triggered by accummulating minutes watched.
- TimeBasedDropSelfEdgeUser specific data associated with this drop.
- TimeseriesItemSingle item of stats for the time series.
- TournamentProgressDescribes the amount of progress that has been made in a tournament, with corresponding milestones about said progress.
- TournamentRewardType containing information about a Reward and claiming information.
- TrackingPixelA tracking pixel is used to measure impressions or demographics.
- TrackingPixelInputThe tracking pixel that will be created as part of this campaign.
- UnbanRequestsSettingsSet of preferences set by the channel owner regarding unban requests.
- UnlockChosenModifiedSubscriberEmoteInputInput for unlocking a chosen modified subscriber emote with Community Points.
- UnlockChosenModifiedSubscriberEmotePayloadThe response from redeeming the unlock a chosen modified subscriber emote reward.
- UnlockChosenSubscriberEmoteInputInput for unlocking a chosen subscriber emote with Community Points.
- UnlockChosenSubscriberEmotePayloadThe response from redeeming the unlock a chosen subscriber emote reward.
- UnlockRandomSubscriberEmoteInputInput for unlocking a random subscriber emote with Community Points.
- UnlockRandomSubscriberEmotePayloadThe response from redeeming the unlock a random subscriber emote reward.
- UpdateAllWhisperThreadsPayload
- UpdateAutoModLevelsInputDefines AutoMod category level settings for a Channel, either overallLevel or detailedAutoModLevels should be non null.
- UpdateAutoModPropertiesInput
- UpdateCelebrationInputInputs for creating a new celebration.
- UpdateChatSettingsInputPossible chat settings modifiable for the channel specified via ChannelID. NOTE: Subscribers-only chat mode settings are in the UpdateSubscriptionProduct mutation.
- UpdateCheerPartnerSettingsChatMessageInputPartner settings related to chat messages with bits.
- UpdateCheerPartnerSettingsRecentCheerInputPartner settings related to the recent cheer message.
- UpdateCommunityPointsAutomaticRewardErrorAn error from updating an automatic Community Points reward in a channel.
- UpdateCommunityPointsAutomaticRewardInputInput for updating an automatic Community Points reward in a channel. Only the channelID and rewardType are required. All other fields are optional. Only set fields that are intended to be updated.
- UpdateCommunityPointsCommunityGoalInputUpdate community goal input.
- UpdateCommunityPointsCustomRewardInputInput for updating a custom Community Points reward in a channel. Only the channelID and rewardID are required. All other fields are optional. Only set fields that are intended to be updated.
- UpdateCompetitionInputUpdate a Competition.
- UpdateCompetitionLeaderboardDetailsInputEditable fields for Leaderboard competition details.
- UpdateDropBenefitInputUpdateDropBenefitInput has fields required to update a drop benefit.
- UpdateDropBenefitOnDropInputUpdateDropBenefitOnDropInput has fields required to update a drop's benefit.
- UpdateHypeTrainConfigInputUpdateHypeTrainConfigInput takes series of optional config settings.
- UpdateLobbyParticipantScoreInputInputs for updating the score for the lobby participant, who is a competition player or competition team, in a competition.
- UpdateRoomError
- UpdateRoomModesError
- UpdateRoomModesInput
- UpdateScheduleSegmentErrorUpdateScheduleSegmentError is a wrapper for error associated with the UpdateScheduleSegment mutation.
- UpdateScheduleSegmentInputThe input to update a schedule segment.
- UpdateStuccoPackItemInputSingle item in a stuccopack, as part of the update stucco pack call, representing one stucco to be used in a certain slot.
- UpdateUserVideoShelvesErrorError information in the update user video shelves response.
- UpdateUserViewedVideoInputInput information for updating a resume watching entry for a specified user and video.
- UpdateVideoStreamSettingsInputUpdateVideoStreamSettingsInput updates the broadcaster's stream settings such as stream delay length seconds or stream key.
- UserTwitch user.
- UserConnectionPaginated list of Users, where the relationship between the source type and the User is generic enough that no information needs to be encoded on the edge.
- UserDropAwardConnectionA list of Drops awarded to the user. // deprecated.
- UserDropRewardA list of Drops awarded to the user via Drops2.0.
- UserLeaderboardUserLeaderboard contains a leaderboard whose entries are Users.
- UserLeaderboardItemUserLeaderboardItem at a specific node in a leaderboard connection.
- UserPredictionStatisticsStatistics concerning how a user has performed when making Predictions in a given channel.
- UserSelfBitsBadgeUserSelfBitsBadge contains the current user's badge tier in a channel and progress toward the next tier. NOTE: should probably have been named CurrentUserBitsBadge.
- UserSelfConnectionSubjective data on another User (user/channel) for the current user.
- Video
- VideoBookmarkA video bookmark.
- VideoCommentComment on a video.
- VideoConnectionA paginated list of videos, and its metadata.
- VideoConnectionOptionsInputOptional input to filter videos. Add any additional optional fields to this input.
- VideoMomentA video moment represents either a point in time, or a duration of time, during which structured metadata is present.
- VideoMutedSegmentInformation about one contiguous muted portion of video.
- VideoOEmbed
- VideoPlayReferralsEndpoints for different video referral sources, based on channel and time range.
- VideoShelfConnectionA paginated list of video shelves with metadata.
- VideoStreamSettingsVideo stream settings for ingesting a stream such as stream key, latency mode, or vod save preference. Represents a user's channel setting when starting a streamm.
- VideoSuggestedSegmentInformation for one suggested video segment.
- VideoViewingHistoryUser's viewing history against a video. All fields are null if no viewing history is available.
- VoteInPollByChoiceIndexInputInputs for voting on a poll by choice index. Poll id and choice id are retrieved from the backend, before sending the vote.
- WatchPartyContains all information for Prime Video Watch Parties.
- WatchPartyItemContains all fields needed to render a watch party item.
- WatchPartyProgressTracks the current state.
- WhisperThreadA conversation between two users.
- WhisperThreadConnectionPaginated list of whisper threads.