openapi: 3.1.0 info: title: YouTube Analytics Analytics Groups LiveChatModerators API description: 'The YouTube Analytics API enables you to retrieve YouTube Analytics data for channels and content owners. Use this API to generate custom analytics reports, track video performance metrics, monitor audience engagement, and gain insights into viewer demographics and behavior patterns. ## Key Features - Retrieve channel and video performance metrics - Access audience demographics and geographic data - Monitor engagement metrics like likes, comments, and shares - Track revenue and ad performance data (for monetized content) - Generate custom date-range reports ## Authentication All API requests require OAuth 2.0 authentication with appropriate scopes. ' version: 2.0.0 contact: name: Google Developers url: https://developers.google.com/youtube/analytics email: youtube-api-support@google.com license: name: Creative Commons Attribution 3.0 url: http://creativecommons.org/licenses/by/3.0/ identifier: CC-BY-3.0 termsOfService: https://developers.google.com/terms/ x-logo: url: https://www.youtube.com/img/desktop/yt_1200.png servers: - url: https://youtubeanalytics.googleapis.com/v2 description: YouTube Analytics API Production Server security: - OAuth2: - https://www.googleapis.com/auth/yt-analytics.readonly tags: - name: LiveChatModerators description: Operations for managing moderators in YouTube live chat paths: /liveChatModerators: get: operationId: youtube.liveChatModerators.list summary: Youtube List Live Chat Moderators description: Lists moderators for a live chat. This list is ordered by date added, with the most recently added moderator first. tags: - LiveChatModerators parameters: - $ref: '#/components/parameters/part' - name: liveChatId in: query required: true description: The liveChatId parameter specifies the YouTube live chat for which the API should return moderators. schema: type: string example: '500123' - $ref: '#/components/parameters/maxResults' - $ref: '#/components/parameters/pageToken' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' responses: '200': description: Successful response containing a list of live chat moderator resources. content: application/json: schema: $ref: '#/components/schemas/LiveChatModeratorListResponse' examples: YoutubeLivechatmoderatorsList200Example: summary: Default youtube.liveChatModerators.list 200 response x-microcks-default: true value: kind: youtube#video etag: XI7nbFXulYBIpL0ayR_gDh3eu1k nextPageToken: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9 prevPageToken: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9 pageInfo: totalResults: 42 resultsPerPage: 10 items: - kind: youtube#video etag: XI7nbFXulYBIpL0ayR_gDh3eu1k id: abc123def456 snippet: liveChatId: '500123' moderatorDetails: {} '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' x-microcks-operation: delay: 0 dispatcher: FALLBACK post: operationId: youtube.liveChatModerators.insert summary: Youtube Add a Live Chat Moderator description: Adds a new moderator for a live chat. The authenticated user must own the live broadcast associated with the chat to add moderators. tags: - LiveChatModerators parameters: - $ref: '#/components/parameters/part' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' requestBody: description: The live chat moderator resource to create. required: true content: application/json: schema: $ref: '#/components/schemas/LiveChatModerator' examples: YoutubeLivechatmoderatorsInsertRequestExample: summary: Default youtube.liveChatModerators.insert request x-microcks-default: true value: kind: youtube#video etag: XI7nbFXulYBIpL0ayR_gDh3eu1k id: abc123def456 snippet: liveChatId: '500123' moderatorDetails: channelId: '500123' channelUrl: https://www.example.com displayName: example_value profileImageUrl: https://www.example.com responses: '200': description: Successful response containing the newly added live chat moderator resource. content: application/json: schema: $ref: '#/components/schemas/LiveChatModerator' examples: YoutubeLivechatmoderatorsInsert200Example: summary: Default youtube.liveChatModerators.insert 200 response x-microcks-default: true value: kind: youtube#video etag: XI7nbFXulYBIpL0ayR_gDh3eu1k id: abc123def456 snippet: liveChatId: '500123' moderatorDetails: channelId: '500123' channelUrl: https://www.example.com displayName: example_value profileImageUrl: https://www.example.com '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: operationId: youtube.liveChatModerators.delete summary: Youtube Remove a Live Chat Moderator description: Removes a chat moderator. The authenticated user must own the live broadcast associated with the chat to remove moderators. tags: - LiveChatModerators parameters: - name: id in: query required: true description: The ID of the live chat moderator to remove. schema: type: string example: abc123def456 - $ref: '#/components/parameters/key' responses: '204': description: The moderator was successfully removed. '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' x-microcks-operation: delay: 0 dispatcher: FALLBACK components: parameters: fields: name: fields in: query description: Selector specifying which fields to include in a partial response. Use this parameter to reduce bandwidth usage by selecting only the fields you need. schema: type: string key: name: key in: query description: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. schema: type: string pageToken: name: pageToken in: query description: Identifies a specific page in the result set that should be returned. The nextPageToken property in the API response identifies other pages that are available. schema: type: string part: name: part in: query required: true description: Specifies a comma-separated list of one or more resource properties that the API response will include. The part parameter value must include the id property. schema: type: string maxResults: name: maxResults in: query description: The maximum number of items that should be returned in the result set. Acceptable values are 0 to 50, inclusive. schema: type: integer minimum: 0 maximum: 50 default: 5 schemas: PageInfo: type: object description: Paging details for a list of live streaming resources. properties: totalResults: type: integer description: The total number of results in the result set. example: 42 resultsPerPage: type: integer description: The number of results included in the API response. example: 10 ErrorResponse: type: object description: A standard error response returned by the YouTube Live Streaming API. properties: error: type: object description: The error details. properties: code: type: integer description: The HTTP status code of the error. message: type: string description: A human-readable description of the error. errors: type: array description: A list of individual errors. items: type: object properties: message: type: string description: A human-readable description of the error. domain: type: string description: The domain in which the error occurred. reason: type: string description: The reason for the error. example: example_value LiveChatModerator: type: object description: A liveChatModerator resource identifies a user who has moderator privileges in a YouTube live chat. required: - kind - etag properties: kind: type: string description: Identifies the API resource's type. Value is youtube#liveChatModerator. default: youtube#liveChatModerator example: youtube#video etag: type: string description: The Etag of this resource. example: XI7nbFXulYBIpL0ayR_gDh3eu1k id: type: string description: The ID that YouTube assigns to uniquely identify the moderator. example: abc123def456 snippet: type: object description: The snippet object contains basic details about the moderator. properties: liveChatId: type: string description: The liveChatId is the live chat id for this moderator resource. moderatorDetails: type: object description: Details about the moderator. properties: channelId: type: string description: The YouTube channel ID of the moderator. channelUrl: type: string description: The channel URL of the moderator. displayName: type: string description: The channel's display name. profileImageUrl: type: string description: The channel's avatar URL. example: example_value LiveChatModeratorListResponse: type: object description: A list of live chat moderator resources for a given live chat. properties: kind: type: string description: Identifies the API resource's type. Value is youtube#liveChatModeratorListResponse. default: youtube#liveChatModeratorListResponse example: youtube#video etag: type: string description: The Etag of this resource. example: XI7nbFXulYBIpL0ayR_gDh3eu1k nextPageToken: type: string description: The token for the next page of results. example: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9 prevPageToken: type: string description: The token for the previous page of results. example: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9 pageInfo: $ref: '#/components/schemas/PageInfo' items: type: array description: A list of moderators that match the request criteria. items: $ref: '#/components/schemas/LiveChatModerator' example: [] responses: Unauthorized: description: The request was not authenticated or the credentials are invalid. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' BadRequest: description: The request was invalid or malformed. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' NotFound: description: The specified resource was not found. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' Forbidden: description: The request was authenticated but the caller does not have permission to perform the requested operation. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' securitySchemes: OAuth2: type: oauth2 description: OAuth 2.0 authentication for YouTube Analytics API flows: authorizationCode: authorizationUrl: https://accounts.google.com/o/oauth2/auth tokenUrl: https://oauth2.googleapis.com/token scopes: https://www.googleapis.com/auth/youtube: Manage your YouTube account https://www.googleapis.com/auth/youtube.readonly: View your YouTube account https://www.googleapis.com/auth/yt-analytics.readonly: View YouTube Analytics reports https://www.googleapis.com/auth/yt-analytics-monetary.readonly: View YouTube Analytics monetary reports externalDocs: description: YouTube Analytics API Documentation url: https://developers.google.com/youtube/analytics