OBJECT

Team

Team 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.

link GraphQL Schema definition

1type Team {
2
3# ID to an image meant to be the background of the Team's landing page.
4backgroundImageID: ID
5
6# URL to an image meant to be the background of the Team's landing page.
7backgroundImageURL: String
8
9# ID to the Team's banner image.
10bannerID: ID
11
12# URL to the Team's banner image.
13bannerURL: String
14
15# Retrieves team stats within the start and end time broken down by granularity.
16# Default end time will be the current time (now).
17# Granularity defaults to 5 minutes.
18# ChannelIDs defaults to all team members.
19creatorTimeseriesMetrics(
20startAt: Time!,
21endAt: Time,
22timeZone: String!,
23granularity: Granularity,
24channelIDs: [ID!]
25): CreatorTimeseriesMetrics
26
27# Information about the team, formatted in Markdown.
28description: String
29
30# Display version of the team name.
31displayName: String!
32
33# The Team's ID.
34id: ID!
35
36# Channels that the Team owner have opted to highlight that are currently live.
37# These channels may or may not also be members of the Team.
38# They will be returned in the order configured by the Team admin.
39liveFeaturedChannels(first: Int, after: Cursor): UserConnection
40
41# Users that belong to the team that are currently live.
42# They will be returned in the order configured by the Team admin.
43liveMembers(first: Int, after: Cursor): UserConnection
44
45# ID to the Team's logo image.
46logoID: ID
47
48# URL to the Team's logo image.
49logoURL: String
50
51# The list of users that belong to this team.
52# They will be returned in the order configured by the Team admin.
53# metricsRevealed allows the client to return all `none`, `statsRevealed`, or
54# `revenueRevealed` members.
55# Defaults to all members to avoid breaking changes.
56members(
57first: Int,
58after: Cursor,
59metricsRevealedFilter: MemberMetricsRevealedParams
60): UserConnection
61
62# The alphanumeric Twitch name of the team.
63name: String!
64
65# Owner is the User that owns and manages the Team.
66owner: User
67
68# Aggregated analytics for several video referral sources, for use in teams
69# dashboard.
70# ChannelIDs defaults to all team members.
71videoPlayReferrals(
72start: Time!,
73end: Time!,
74filter: ReferralsFilter,
75dimension: ReferralsDimension!,
76first: Int,
77channelIDs: [ID!]
78): VideoPlayReferrals
79
80}

link Required by