YouTube Analytics Connector Objects
| Name | Description |
|---|---|
| Activities | Query YouTube Activities. An Activity resource contains information about an action that a particular Channel, or User, has taken on YouTube. |
| AdPerformanceReports | Query Ad Performance Reports. Ad Performance Reports provide impression-based metrics for ads that ran during video playbacks. These metrics account for each ad impression, and each video playback can yield multiple impressions. |
| AudienceRetention | This report measures a video's ability to retain its audience. |
| Captions | Query YouTube Captions. A Caption resource represents a YouTube caption track. |
| Channels | Query YouTube Channels. |
| ChannelSections | Query YouTube ChannelSections. A ChannelSection contains information about a set of Videos that a Channel has chosen to feature. |
| Comments | Query YouTube Comments. |
| CommentThreads | Query YouTube CommentThreads. A CommentThread record contains information about a YouTube comment thread, a top-level comment and replies, if any exist, to that comment. |
| Demographics | Query YouTubeAnalytics Demographics grouped by age groups and gender. |
| Devices | Query YouTubeAnalytics Devices statistics. This table allows you to aggregate viewing statistics based on the manner in which viewers reached your video content. For example, you can identify the number of views that occurred on mobile devices or game consoles. |
| EngagementReports | Query Engagement Reports info. For example, how many times a user shared a video. |
| GroupItems | Create, delete, and query Items that compose a Group. |
| Groups | Create, update, delete, and query YouTube Analytics Groups. |
| Languages | Query YouTube i18nLanguages. An i18nLanguage resource identifies an application language that the YouTube website supports. The application language can also be referred to as a UI language. |
| MostPopularVideosByCategory | Query YouTube Videos. |
| MostPopularVideosByRegion | Query YouTube Videos. |
| MyDislikedVideos | Query YouTube Liked Videos. |
| MyLikedVideos | Query YouTube Liked Videos. |
| OperatingSystems | Query YouTubeAnalytics Operating Systems statistics. This report aggregates viewing statistics based on viewers' operating systems. For example, it identifies the number of views that occurred on Android devices or on PlayStations. |
| PlayListItems | Query YouTube PlayListItems. A PlayListItem resource identifies another YouTube entity, such as a Video, that is included in a PlayList. In addition, the PlayListItem record contains details about how that entity is used in that PlayList. |
| PlayLists | Query YouTube PlayLists. A PlayList is a collection of videos that can be viewed sequentially and shared with other users. |
| Regions | Query YouTube i18nRegions. An i18nRegion resource identifies a geographic area that a YouTube user can select as the preferred content region. The content region can also be referred to as a content locale. |
| Subscriptions | Query YouTube User Subscriptions. A Subscription notifies a User when new Videos are added to a Channel, or when another user takes one of several actions on YouTube, such as uploading a Video, rating a Video, or commenting on a Video. |
| TimeBasedReports | Query time-based info on views, subscribers, etc. For example, how many new subscribers were gained at a specific time. |
| TopPlaylists | Query the TopPlaylists for a channel. You can also use this view to query playback detail and geographic filters. |
| TopVideos | Query the TopVideos for a channel. You can also use this view to query playback detail and geographic filters. |
| TrafficSources | Query TrafficSources. Statistics are based on the manner in which viewers reached your video and playlist content. |
| UserActivityByCity | This report provides user activity statistics by city. |
| UserActivityByCountry | This report provides user activity statistics. |
| UserActivityByProvince | This report provides user activity statistics, sorted by province (includes Washington DC). |
| VideoAbuseReportReasons | Query YouTube VideoAbuseReportReasons. A VideoAbuseReportReason resource contains information about a reason that a Video would be flagged for containing abusive content. |
| VideoCategories | Query YouTube VideoCategories. A VideoCategory resource identifies a category that has been or could be associated with uploaded Videos. |
| Videos | Query YouTube Videos. |
| Name | Type | ReadOnly | References | FilterOnly | Description |
|---|---|---|---|---|---|
| Id [KEY] | String | False | No | The Id that YouTube uses to uniquely identify the activity. | |
| PublishedAt | Datetime | False | No | The date and time that the activity occurred. The value is in ISO 8601 (YYYY-MM-DDThh:mm | |
| ChannelId | String | False | No | The Id that YouTube uses to uniquely identify the channel associated with the activity. | |
| Title | String | False | No | The title of the resource primarily associated with the activity. | |
| Description | String | False | No | The description of the resource primarily associated with the activity. | |
| ChannelTitle | String | False | No | Channel title for the channel responsible for this activity. | |
| Type | String | False | No | The type of activity that the resource describes. Valid values: channelItem, comment (not currently returned), favorite, like, playlistItem, recommendation, social, subscription, and upload. | |
| GroupId | String | False | No | The group Id associated with the activity. | |
| ThumbnailsDefaultUrl | String | False | No | The URL of the default image thumbnail. | |
| UploadVideoId | String | False | No | The Id that YouTube uses to uniquely identify the uploaded video. | |
| LikeResourceIdKind | String | False | No | The type of the resource that received a positive (like) rating. | |
| LikeResourceIdVideoId | String | False | No | The Id that YouTube uses to uniquely identify the video, if the rated resource is a video. This column is only present if the ResourceIdKind is youtube#video. | |
| FavoriteResourceIdKind | String | False | No | The type of the YouTube entity marked as a favorite. | |
| FavoriteResourceIdVideoId | String | False | No | The Id that YouTube uses to uniquely identify the favorite video. | |
| CommentResourceIdKind | String | False | No | The comment on the API resource. | |
| CommentResourceIdVideoId | String | False | No | The Id that YouTube uses to uniquely identify the video associated with a comment. | |
| CommentResourceIdChannelId | String | False | No | The Id that YouTube uses to uniquely identify the channel associated with a comment. | |
| SubscriptionResourceIdKind | String | False | No | The type of the subscription. A subscription is a channel that a user subscribed to. | |
| SubscriptionResourceIdChannelId | String | False | No | The Id that YouTube uses to uniquely identify the channel that the user subscribed to. | |
| PlaylistItemResourceIdKind | String | False | No | The type of the playlist item. | |
| PlaylistItemResourceIdVideoId | String | False | No | The Id that YouTube uses to uniquely identify the video that was added to the playlist. | |
| PlaylistItemPlaylistId | String | False | No | The value that YouTube uses to uniquely identify the playlist. | |
| PlaylistItemPlaylistItemId | String | False | No | The value that YouTube uses to uniquely identify the item in the playlist. | |
| RecommendationResourceIdKind | String | False | No | The type of the recommendation. | |
| RecommendationResourceIdVideoId | String | False | No | The Id that YouTube uses to uniquely identify the video, if the recommended resource is a video. | |
| RecommendationResourceIdChannelId | String | False | No | The Id that YouTube uses to uniquely identify the channel, if the recommended resource is a channel. | |
| RecommendationReason | String | False | No | The reason that the YouTube entity was recommended to the user. Valid values for this column : unspecified, videoFavorited, videoLiked, and videoWatched. | |
| RecommendationSeedResourceIdKind | String | False | No | The type of the YouTube entity that caused the recommendation. | |
| RecommendationSeedResourceIdVideoId | String | False | No | The Id that YouTube uses to uniquely identify the video, if the recommendation was caused by a particular video. | |
| RecommendationSeedResourceIdChannelId | String | False | No | The Id that YouTube uses to uniquely identify the channel, if the recommendation was caused by a particular channel. | |
| RecommendationSeedResourceIdPlaylistId | String | False | No | The Id that YouTube uses to uniquely identify the playlist, if the recommendation was caused by a particular playlist. | |
| SocialType | String | False | No | The name of the social network post. Valid values for this column: facebook, googlePlus, twitter, and unspecified. | |
| SocialResourceIdKind | String | False | No | The type of the social network post. | |
| SocialResourceIdVideoId | String | False | No | The Id that YouTube uses to uniquely identify the video featured in a social network post, if the post refers to a video. | |
| SocialResourceIdChannelId | String | False | No | The Id that YouTube uses to uniquely identify the channel featured in a social network post, if the post refers to a channel. | |
| SocialResourceIdPlaylistId | String | False | No | The Id that YouTube uses to uniquely identify the playlist featured in a social network post. | |
| SocialAuthor | String | False | No | The author of the social network post. | |
| SocialReferenceUrl | String | False | No | The URL of the social network post. | |
| SocialImageUrl | String | False | No | An image of the author of the post. | |
| ChannelItemResourceId | String | False | No | The Id of the YouTube entity that was added to the channel. | |
| Region | String | False | Yes | Instructs the API to filter by region. The parameter value is an ISO 3166-1 alpha-2 country code. |
| Name | Type | ReadOnly | References | FilterOnly | Description |
|---|---|---|---|---|---|
| AdType | String | True | No | The AdType dimension is used in ad performance reports and aggregates the requested metrics based on the types of ads that ran during video playbacks: auctionDisplay, auctionInstream, auctionTrueviewInslate, auctionTrueviewInstream, auctionUnknown, reservedClickToPlay, reservedDisplay, reservedInstream, reservedInstreamSelect, reservedMasthead, reservedUnknown. | |
| Day | String | True | No | When you use this dimension, data in the report is aggregated on a daily basis and each row contains data for one day. | |
| GrossRevenue | Decimal | True | No | The estimated gross revenue, in USD, from all Google-sold or DoubleClick-partner-sold advertising for the selected date range and region. Gross revenue is subject to month-end adjustment and does not include partner-served advertising. Gross revenue should not be confused with earnings, or net revenue, which factors in your share of ownership and revenue-sharing agreements. | |
| AdImpressions | Double | True | No | The number of verified ad impressions served. | |
| Cpm | Decimal | True | No | The estimated gross revenue per thousand ad impressions. | |
| Video | String | True | No | The Id of a YouTube video. | |
| Group | String | True | No | (filter only) The Id of a YouTube Analytics group. | |
| ClaimedStatus | String | True | No | (only used in content owner reports) This dimension lets you indicate that a result set should only contain metrics for claimed content. The allowed value is claimed. | |
| UploaderType | String | True | No | (only used in content owner reports) This dimension lets you indicate whether a result set should contain metrics for content uploaded by the specified content owner or content uploaded by third parties, such as user-uploaded videos. The allowed values are self and thirdParty. | |
| Country | String | True | No | The country associated with the metrics in the report row. The dimension value is a two-letter ISO-3166-1 country code, such as US, CN (China), or FR (France). The country code ZZ is used to report metrics for which YouTube could not identify the associated country. | |
| Continent | String | True | No | (filter only) A United Nations (U.N.) statistical region code. The allowed values are 002 Africa, 019 Americas (Northern America, Latin America, South America, and the Caribbean), 142 Asia, 150 Europe, 009 Oceania. This dimension can only be used to filter data. | |
| SubContinent | String | True | No | (filter only) A U.N. statistical region code that identifies a geographical subregion. | |
| StartDate | Date | True | No | Start date for fetching Analytics data. | |
| EndDate | Date | True | No | End date for fetching Analytics data. | |
| Segments | String | False | Yes | Segments the data returned for your request. Either a SegmentId or a custom segment. |
| Name | Type | ReadOnly | References | FilterOnly | Description |
|---|---|---|---|---|---|
| ElapsedVideoTimeRatio | String | False | No | This dimension specifies the ratio of the elapsed portion of the video to the video's length. | |
| CreatorContentType | String | False | No | This dimension identifies the type of content associated with the user activity metrics in the data row. The allowed values are LIVE_STREAM, SHORTS, STORY, VIDEO_ON_DEMAND, UNSPECIFIED. | |
| AudienceWatchRatio | Double | False | No | The absolute ratio of viewers watching the video at the given point in the video. | |
| RelativeRetentionPerformance | Double | False | No | A measurement that shows how well a video retains viewers during playbacks in comparison to all YouTube videos of similar length. | |
| StartedWatching | Int64 | False | No | The number of times a particular segment of the video was the first segment seen during a video playback. | |
| StoppedWatching | Int64 | False | No | The number of times a particular segment of the video was the last segment seen during a video playback. | |
| TotalSegmentImpressions | Int64 | False | No | The number of times a particular segment of a video was viewed. | |
| Video | String | False | No | The Id of a YouTube video. | |
| AudienceType | String | False | No | The dimension value identifies the type of traffic associated with the report data. Supported values are ORGANIC, AD_INSTREAM, and AD_INDISPLAY. | |
| SubscribedStatus | String | False | No | This dimension indicates whether the user activity metrics in the data row are associated with viewers who were subscribed to the video or playlist channel. Possible values are SUBSCRIBED and UNSUBSCRIBED. Note that the dimension value is accurate as of the time that the user activity occurs. | |
| YoutubeProduct | String | False | No | This dimension identifies the YouTube service on which the user activity occurred. Data for this dimension is available as of July 18, 2015. The allowed values are CORE, GAMING, KIDS, UNKNOWN. | |
| StartDate | Date | False | No | Start date for fetching Analytics data. Either a date string or a relative date (e.g., today, yesterday, or #daysAgo). | |
| EndDate | Date | False | No | End date for fetching Analytics data. Either a date string or a relative date (e.g., today, yesterday, or #daysAgo). |
| Name | Type | ReadOnly | References | FilterOnly | Description |
|---|---|---|---|---|---|
| Id [KEY] | String | False | No | The Id that YouTube uses to uniquely identify the caption track. | |
| VideoId | String | False | Videos.ID | No | The Id that YouTube uses to uniquely identify the video associated with the caption track. |
| LastUpdated | Datetime | False | No | The date and time when the caption track was last updated. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm | |
| TrackKind | String | False | No | The type of the caption track. Valid values for this column: ASR (a caption track generated using automatic speech recognition); Forced (a caption track that plays when no other track is selected in the player. For example, a video that shows aliens speaking in an alien language might have a forced caption track to only show subtitles for the alien language); standard (a regular caption track. This is the default value). | |
| Language | String | False | No | The language of the caption track. The column value is a BCP-47 language tag. | |
| Name | String | False | No | The name of the caption track. The name is intended to be visible to the user as an option during playback. | |
| AudioTrackType | String | False | No | The type of audio track associated with the caption track. Valid values for this column: commentary (the caption track corresponds to an alternate audio track that includes commentary, such as director commentary); descriptive (the caption track corresponds to an alternate audio track that includes additional descriptive audio); primary (the caption track corresponds to the primary audio track for the video, which is the audio track normally associated with the video); unknown (this is the default value). | |
| IsCC | Boolean | False | No | Indicates whether the track contains closed captions for the deaf and hard of hearing. The default value is false. | |
| IsLarge | Boolean | False | No | Indicates whether the caption track uses large text for the vision-impaired. The default value is false. | |
| IsEasyReader | Boolean | False | No | Indicates whether the caption track is formatted for easy reader, meaning it is at a third-grade level for language learners. The default value is false. | |
| IsDraft | Boolean | False | No | Indicates whether the caption track is a draft. If the value is true, then the track is not publicly visible. The default value is false. | |
| IsAutoSynced | Boolean | False | No | Indicates whether YouTube synchronized the caption track to the audio track in the video. The value will be true if a sync was explicitly requested when the caption track was uploaded. If the value is false, YouTube uses the time codes in the uploaded caption track to determine when to display captions. | |
| Status | String | False | No | The status of the caption track. Valid values for this column: failed, serving, syncing. | |
| FailureReason | String | False | No | The reason that YouTube failed to process the caption track. Valid values: processingFailed (YouTube failed to process the uploaded caption track); unknownFormat (the format of the caption track was not recognized); unsupportedFormat (the format of the caption track is not supported). |
| Name | Type | ReadOnly | References | FilterOnly | Description |
|---|---|---|---|---|---|
| Id [KEY] | String | False | No | The Id that YouTube uses to uniquely identify the channel. | |
| Title | String | False | No | The title of the channel. | |
| Description | String | False | No | The description of the channel. The value of the column has a maximum length of 1000 characters. | |
| CustomUrl | String | False | No | The channel's custom URL. | |
| PublishedAt | Datetime | False | No | The date and time that the channel was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm | |
| ThumbnailsDefaultUrl | String | False | No | The URL of the default image thumbnail. | |
| DefaultLanguage | String | False | No | This column is confidential to trusted testers. | |
| LiveBroadcastContent | String | False | No | An indication of whether a video or channel resource has live broadcast content. | |
| LocalizedTitle | String | False | No | This column is confidential to trusted testers. The localized video title. | |
| LocalizedDescription | String | False | No | This column is confidential to trusted testers. The localized video description. | |
| Country | String | False | No | The country with which the channel is associated. | |
| ViewCount | Long | False | No | The number of times the channel has been viewed. | |
| SubscriberCount | Long | False | No | The number of subscribers that the channel has. This value is rounded down to three significant figures. | |
| HiddenSubscriberCount | Boolean | False | No | Indicates whether the subscriber count of the channel is publicly visible. | |
| VideoCount | Long | False | No | The number of videos uploaded to the channel. | |
| RelatedPlaylistsLikes | String | False | No | The Id of the playlist that contains the liked videos of the channel. | |
| RelatedPlaylistsUploads | String | False | No | The Id of the playlist that contains the uploaded videos of the channel. | |
| PrivacyStatus | String | False | No | Privacy status of the channel. Valid values for this column: private, public, unlisted. | |
| IsLinked | Boolean | False | No | Indicates whether the channel data identifies a user who is already linked to either a YouTube username or a Google+ account. A user who has one of these links already has a public YouTube identity, which is a prerequisite for several actions, such as uploading videos. | |
| LongUploadsStatus | String | False | No | Indicates whether the channel is eligible to upload videos that are more than 15 minutes long. This column is only returned if the channel owner authorized the API request. See the YouTube Help Center for more information about this feature. | |
| MadeForKids | Boolean | False | No | This value indicates whether the channel is designated as child-directed, and it contains the current 'made for kids' status of the channel. | |
| Keywords | String | False | No | Keywords associated with your channel. The value is a space-separated list of strings. | |
| TrackingAnalyticsAccountId | String | False | No | The Id for a Google Analytics account that you want to use to track and measure traffic to your channel. | |
| ModerateComments | Boolean | False | No | This setting determines whether user-submitted comments left on the channel page need to be approved by the channel owner to be publicly visible. The default value is false. | |
| SearchTerms | String | False | No | The SearchTerms parameter specifies the query term to search for. | |
| ForUsername | String | False | Yes | The username associated with the channel. | |
| Language | String | False | Yes | Retrieve localized resource metadata for a specific application language that the YouTube website supports. | |
| Language | String | False | Yes | Retrieve localized resource metadata for a specific application language that the YouTube website supports. | |
| ManagedByMe | String | False | Yes | This parameter is intended exclusively for YouTube content partners. Set this parameter's value to true to instruct the API to only return channels managed by the content owner that the onBehalfOfContentOwner parameter specifies. The user must be authenticated as a CMS account linked to the specified content owner and onBehalfOfContentOwner must be provided. | |
| OnBehalfOfContentOwner | String | False | Yes | This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner. | |
| ChannelId | String | False | Yes | The Id that YouTube uses to uniquely identify a channel. | |
| Region | String | False | Yes | The country associated with the channel. | |
| SafeSearch | String | False | Yes | Indicates whether the search results should include restricted content as well as standard content. Acceptable values: moderate, none, or strict. | |
| Rating | String | False | Yes | Resources are sorted from highest to lowest rating. | |
| Relevance | String | False | Yes | Resources are sorted based on their relevance to the search query. This is the default value for this parameter. |
| Name | Type | ReadOnly | References | FilterOnly | Description |
|---|---|---|---|---|---|
| Id [KEY] | String | False | No | The Id that YouTube uses to uniquely identify the channel section. | |
| Type | String | False | No | The type of the channel section. | |
| ChannelId | String | False | Channels.ID | No | The Id that YouTube uses to uniquely identify the channel. |
| Title | String | False | No | The title of the section. | |
| Position | Integer | False | No | The position of the section on the channel page. | |
| PlaylistsAggregate | String | False | No | A list of one or more playlist Ids that are featured in a channel section. You must specify a list of playlist Ids if the type of the ChannelSection is either singlePlaylist or multiplePlaylists, and this column should not be specified for other types of sections. If the type is singlePlaylist, this list must specify exactly one playlist Id. | |
| ChannelsAggregate | String | False | No | A list of one or more channel Ids that are featured in a channel section. You must specify a list of channel Ids if the Type of the ChannelSection is multipleChannels, and this column should not be specified for other types of sections. You cannot include your own channel in the list. | |
| Language | String | False | Yes | Retrieve localized resource metadata for a specific application language that the YouTube website supports. | |
| OnBehalfOfContentOwner | String | False | Yes | This parameter is intended exclusively for YouTube content partners. |
| Name | Type | ReadOnly | References | FilterOnly | Description |
|---|---|---|---|---|---|
| Id [KEY] | String | False | No | The Id that YouTube uses to uniquely identify the comment. | |
| ChannelId | String | False | Channels.ID | No | The Id of the YouTube channel associated with the comment. If the comment is a video comment, then this column identifies the channel of the video, and the VideoId column identifies the video. If the comment is a channel comment, then this column identifies the channel that the comment is about. |
| VideoId | String | False | Videos.ID | No | The Id of the video that the comment refers to. |
| TextDisplay | String | False | No | The text of the comment. The text can be retrieved in either plaintext or HTML. The TextFormat pseudo column specifies the desired text format. | |
| TextOriginal | String | False | No | The original, raw text of the comment as it was initially posted or last updated. The original text is only returned if it is accessible to the authenticated user, which is only guaranteed if the user is the author of the comment. | |
| ParentId | String | False | No | The unique Id of the parent comment. This column value is only set if the comment was submitted as a reply to another comment. | |
| AuthorDisplayName | String | False | No | The display name of the user who posted the comment. | |
| AuthorProfileImageUrl | String | False | No | The URL for the avatar of the user who posted the comment. | |
| AuthorChannelUrl | String | False | No | The URL of the YouTube channel of the comment author, if available. | |
| AuthorChannelIdValue | String | False | No | The Id of the YouTube channel of the comment author, if available. | |
| AuthorGoogleplusProfileUrl | String | False | No | The URL of the Google+ profile of the comment author, if available. | |
| CanRate | Boolean | False | No | This setting indicates whether the current viewer can rate the comment. | |
| ViewerRating | String | False | No | The rating the viewer has given to this comment. Valid values for this column: like, none. Note that this column does not currently identify dislike ratings. The column value is like if the viewer has rated the comment positively. The value is none in all other cases, including the user having given the comment a negative rating or not having rated the comment. | |
| LikeCount | Integer | False | No | The total number of likes (positive ratings) the comment has received. | |
| ModerationStatus | String | False | No | The moderation status of the comment. This value is only returned if the API request was authorized by the owner of the channel or the video on which the requested comments were made. In addition, note that this value is not set if the query filtered on the Id column. Valid values: heldForReview, likelySpam, published, rejected. | |
| PublishedAt | Datetime | False | No | The date and time when the comment was orignally published. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm | |
| UpdatedAt | Datetime | False | No | The date and time when the comment was last updated. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm | |
| TextFormat | String | False | Yes | This parameter indicates whether the API should return comments formatted as HTML or as plaintext. |
| Name | Type | ReadOnly | References | FilterOnly | Description |
|---|---|---|---|---|---|
| Id [KEY] | String | False | No | The Id that YouTube uses to uniquely identify the comment thread. | |
| ChannelId | String | False | Channels.ID | No | The YouTube channel that is associated with the comments in the thread. The VideoId column identifies the video. If the comments are about a video, then the value identifies the channel that uploaded the video. If the comments refer to the channel itself, the VideoId column will not have a value. |
| VideoId | String | False | Videos.ID | No | The Id of the video that the comments refer to, if any. If this column is not present or does not have a value, then the thread applies to the channel and not to a specific video. |
| TopCommentId | String | False | No | The Id of the top-level comment of the thread. | |
| PublishedAt | Datetime | False | No | The publish date of the top-level comment of the thread. | |
| UpdatedAt | Datetime | False | No | The last update date of the top-level comment of the thread. | |
| TopCommentChannelId | String | False | No | The Id of the channel associated with the top-level comment of the thread. | |
| TopCommentVideoId | String | False | No | The Id of the video associated with the top-level comment of the thread. | |
| TopCommentTextDisplay | String | False | No | The display text of the top-level comment of the thread. | |
| TopCommentTextOriginal | String | False | No | The original text of the top-level comment of the thread. | |
| TopCommentParentId | String | False | No | The Id of the parent of the top-level comment of the thread. | |
| TopCommentAuthorDisplayName | String | False | No | The display name of the author of the top-level comment of the thread. | |
| TopCommentAuthorChannelIdValue | String | False | No | The Id of the channel of the author of the top-level comment of the thread. | |
| TopCommentCanRate | Boolean | False | No | Whether the current user can rate the top-level comment of the thread. | |
| TopCommentViewerRating | String | False | No | The viewer rating of the top-level comment of the thread. | |
| TopCommentLikeCount | Integer | False | No | The like count of the top-level comment of the thread. | |
| TopCommentModerationStatus | String | False | No | The moderation status of the top-level comment of the thread. | |
| CanReply | Boolean | False | No | This setting indicates whether the current viewer can reply to the thread. | |
| TotalReplyCount | Integer | False | No | The total number of replies that have been submitted in response to the top-level comment. | |
| IsPublic | Boolean | False | No | This setting indicates whether the thread, including all of its comments and comment replies, is visible to all YouTube users. | |
| CommentsAggregate | String | False | No | A list of one or more replies to the top-level comment. | |
| AllThreadsRelatedToChannelId | String | False | Yes | Instructs the API to return all comment threads associated with the specified channel. | |
| ModerationStatus | String | False | Yes | Set this parameter to limit the returned comment threads to a particular moderation state. | |
| TextFormat | String | False | Yes | Set the value of this parameter to HTML or plainText. |
| Name | Type | ReadOnly | References | FilterOnly | Description |
|---|---|---|---|---|---|
| AgeGroup | String | False | No | This dimension identifies the age group of the logged-in users associated with the report data. The allowed values are age13-17, age18-24, age25-34, age35-44, age45-54, age55-64, age65- | |
| Gender | String | False | No | This dimension identifies the gender of the logged-in users associated with the query. The allowed values are female, male and user_specified. | |
| CreatorContentType | String | False | No | This dimension identifies the type of content associated with the user activity metrics in the data row. The allowed values are LIVE_STREAM, SHORTS, STORY, VIDEO_ON_DEMAND, UNSPECIFIED. | |
| LiveOrOnDemand | String | False | No | This dimension indicates whether the user activity metrics in the data row are associated with views of a live broadcast. Data for this dimension is available for dates beginning April 1, 2014. The allowed values are LIVE, ON_DEMAND. | |
| SubscribedStatus | String | False | No | This dimension indicates whether the user activity metrics in the data row are associated with viewers who were subscribed to the video or playlist channel. The allowed values are SUBSCRIBED and UNSUBSCRIBED. Note that the dimension value is accurate as of the time that the user activity occurs. | |
| ViewerPercentage | Double | False | No | The percentage of viewers who were logged in when watching the video or playlist. The viewerPercentage values in this report are not normalized for different values or combinations of values for playback detail dimensions (subscribedStatus and youtubeProduct). For example, a report that uses the subscribedStatus dimension returns viewerPercentage data adding up to 100 percent for subscribed views and viewerPercentage data adding up to 100 percent for unsubscribed views. (The total value of all viewerPercentage fields in the report is 200 percent.) You can use filters to ensure that the report only contains viewerPercentage data for one value (or combination of values) for playback detail dimensions. | |
| Video | String | False | No | The Id of a YouTube video. | |
| Playlist | String | False | No | The Id of a YouTube playlist. | |
| Group | String | False | No | (filter only) The Id of a YouTube Analytics group. | |
| UploaderType | String | False | No | (only used in content owner reports) This dimension lets you indicate whether a result set will contain metrics for content uploaded by the specified content owner or content uploaded by third parties, such as user-uploaded videos. The allowed values are self and thirdParty. | |
| ClaimedStatus | String | False | No | (only used in content owner reports) This dimension lets you indicate that a result set will only contain metrics for claimed content. The allowed value is claimed. | |
| Country | String | False | No | The country associated with the metrics in the report row. The dimension value is a two-letter ISO-3166-1 country code, such as US, CN (China), or FR (France). The country code ZZ is used to report metrics for which YouTube could not identify the associated country. | |
| Province | String | False | No | The U.S. state or territory associated with the metrics in the report row. The dimension value is an ISO 3166-2 code that identifies a U.S. state or the District of Columbia, such as US-MI (Michigan) or US-TX (Texas). The province code US-ZZ is used to report metrics for which YouTube could not identify the associated U.S. state. If the Province column is specified, Country must be set to US in the WHERE clause. | |
| Continent | String | False | No | (filter only) A United Nations (U.N.) statistical region code. The API supports the following values: 002 Africa, 019 Americas (Northern America, Latin America, South America, and the Caribbean), 142 Asia, 150 Europe, 009 Oceania. | |
| SubContinent | String | False | No | (filter only) A U.N. statistical region code that identifies a geographical subregion. | |
| StartDate | Date | False | No | Start date for fetching Analytics data. | |
| EndDate | Date | False | No | End date for fetching Analytics data. | |
| Segments | String | False | Yes | Segments the data returned for your request. Either a SegmentId or a custom segment. |
| Name | Type | ReadOnly | References | FilterOnly | Description |
|---|---|---|---|---|---|
| DeviceType | String | False | No | This dimension identifies the physical form factor of the device on which the view occurred. The allowed values are DESKTOP, GAME_CONSOLE, MOBILE, TABLET, TV, UNKNOWN_PLATFORM. | |
| CreatorContentType | String | False | No | This dimension identifies the type of content associated with the user activity metrics in the data row. The allowed values are LIVE_STREAM, SHORTS, STORY, VIDEO_ON_DEMAND, UNSPECIFIED. | |
| Day | String | False | No | When you use this dimension, data in the report is aggregated on a daily basis and each row contains data for one day. | |
| LiveOrOnDemand | String | False | No | This dimension indicates whether the user activity metrics in the data row are associated with views of a live broadcast. Data for this dimension is available for dates beginning April 1, 2014. The allowed values are LIVE, ON_DEMAND. | |
| SubscribedStatus | String | False | No | This dimension indicates whether the user activity metrics in the data row are associated with viewers who were subscribed to the video or playlist channel. The allowed values are SUBSCRIBED, UNSUBSCRIBED. Note that the dimension value is accurate as of the time that the user activity occurs. | |
| YoutubeProduct | String | False | No | This dimension identifies the YouTube service on which the user activity occurred. Data for this dimension is available as of July 18, 2015. The allowed values are CORE, GAMING, KIDS, UNKNOWN. | |
| Views | Double | False | No | The number of times that a video was viewed. | |
| EstimatedMinutesWatched | Double | False | No | The number of minutes that users watched videos for the specified channel, content owner, video, or playlist. | |
| AverageViewDuration | Double | False | No | The average length, in seconds, of video playbacks. As of December 13, 2021, this metric excludes looping clips traffic. In a playlist report, the metric indicates the average length, in seconds, of video playbacks that occurred in the context of a playlist. | |
| AverageTimeInPlaylist | Double | False | No | The estimated average amount of time, in minutes, that a viewer viewed videos in a playlist after the playlist was initiated. Note that this metric includes only playlist views that occurred on the web. | |
| PlaylistAverageViewDuration | Double | False | No | The estimated average length, in seconds, watched per playlist view. Note that this metric represents the average length of views of individual videos within a playlist; the averageTimeInPlaylist metric, by contrast, represents the average time each viewer spends watching the playlist as a whole. This metric includes data for playlist videos that are owned by other channels. | |
| PlaylistEstimatedMinutesWatched | Double | False | No | The number of minutes that users watched the playlist content as a part of the playlist. Watch time that occurred in other contexts?for example, watch time from views that occurred when viewers were watching the same video as part of other playlists?is not counted. This metric includes data for playlist videos that are owned by other channels. | |
| PlaylistStarts | Double | False | No | The number of times that viewers initiated playback of a playlist. Note that this metric includes only playlist views that occurred on the web. | |
| PlaylistViews | Double | False | No | The number of times that videos in the playlist were viewed in the context of that playlist. This metric includes data for playlist videos that are owned by other channels. | |
| ViewsPerPlaylistStart | Double | False | No | The average number of video views that occurred each time a playlist was initiated. | |
| Country | String | False | No | The country associated with the metrics in the report row. The dimension value is a two-letter ISO-3166-1 country code, such as US, CN (China), or FR (France). The country code ZZ is used to report metrics for which YouTube could not identify the associated country. | |
| Province | String | False | No | The U.S. state or territory associated with the metrics in the report row. The dimension value is an ISO 3166-2 code that identifies a U.S. state or the District of Columbia, such as US-MI (Michigan) or US-TX (Texas). The province code US-ZZ is used to report metrics for which YouTube could not identify the associated U.S. state. If the Province column is specified, Country must be set to US in the WHERE clause. | |
| Continent | String | False | No | (filter only) A United Nations (U.N.) statistical region code: 002 Africa, 019 Americas (Northern America, Latin America, South America, and the Caribbean), 142 Asia, 150 Europe, 009 Oceania. This dimension can only be used to filter data. | |
| SubContinent | String | False | No | (filter only) A U.N. statistical region code that identifies a geographical subregion. | |
| Video | String | False | No | The Id of a YouTube video. | |
| Playlist | String | False | No | The Id of a YouTube playlist. | |
| Group | String | False | No | (filter only) The Id of a YouTube Analytics group. | |
| ClaimedStatus | String | False | No | (only used in content owner reports) This dimension lets you indicate that the result set will only contain metrics for claimed content. The allowed value is claimed. | |
| UploaderType | String | False | No | (only used in content owner reports) This dimension lets you indicate whether the result set will contain metrics for content uploaded by the specified content owner or content uploaded by third parties, such as user-uploaded videos. The allowed values are self and thirdParty. | |
| OperatingSystem | String | False | No | This dimension identifies the software system of the device on which the view occurred. The allowed values are ANDROID, BADA, BLACKBERRY, DOCOMO, HIPTOP, IOS, LINUX, MACINTOSH, MEEGO, NINTENDO_3DS, OTHER, PLAYSTATION, PLAYSTATION_VITA, SMART_TV, SYMBIAN, WEBOS. | |
| StartDate | Date | False | No | Start date for fetching Analytics data. | |
| EndDate | Date | False | No | End date for fetching Analytics data. | |
| Segments | String | False | Yes | Segments the data returned for your request. Either a SegmentId or a custom segment. |
| Name | Type | ReadOnly | References | FilterOnly | Description |
|---|---|---|---|---|---|
| SharingService | String | False | No | This dimension identifies the service that was used to share videos. Videos can be shared on YouTube (or via the YouTube player) using the Share button. | |
| CreatorContentType | String | False | No | This dimension identifies the type of content associated with the user activity metrics in the data row. The allowed values are LIVE_STREAM, SHORTS, STORY, VIDEO_ON_DEMAND, UNSPECIFIED. | |
| SubscribedStatus | String | False | No | This dimension indicates whether the user activity metrics in the data row are associated with viewers who were subscribed to the video or playlist channel. Possible values are SUBSCRIBED and UNSUBSCRIBED. Note that the dimension value is accurate as of the time that the user activity occurs. | |
| Shares | Double | False | No | The number of times that users shared a video through the Share button. | |
| Country | String | False | No | The country associated with the metrics in the report row. The dimension value is a two-letter ISO-3166-1 country code, such as US, CN (China), or FR (France). The country code ZZ is used to report metrics for which YouTube could not identify the associated country. | |
| Continent | String | False | No | (filter only) A United Nations (U.N.) statistical region code: 002 Africa, 019 Americas (Northern America, Latin America, South America, and the Caribbean), 142 Asia, 150 Europe, 009 Oceania. This dimension can only be used to filter data. | |
| SubContinent | String | False | No | (filter only) A U.N. statistical region code that identifies a geographical subregion. | |
| Channel | String | False | No | (only used in content owner reports) The Id for a YouTube channel. The channel dimension is frequently used in content owner reports because those reports typically aggregate data for multiple channels. | |
| Video | String | False | No | The Id of a YouTube video. | |
| Group | String | False | No | (filter only) The Id of a YouTube Analytics group. | |
| ClaimedStatus | String | False | No | (only used in content owner reports) This dimension lets you indicate that a result set will only contain metrics for claimed content. The allowed value is claimed. | |
| UploaderType | String | False | No | (only used in content owner reports) This dimension lets you indicate whether a result set will contain metrics for content uploaded by the specified content owner or content uploaded by third parties, such as user-uploaded videos. The allowed values are self and thirdParty. | |
| StartDate | Date | False | No | Start date for fetching Analytics data. | |
| EndDate | Date | False | No | End date for fetching Analytics data. | |
| Segments | String | False | Yes | Segments the data returned for your request. Either a SegmentId or a custom segment. |
| Name | Type | ReadOnly | References | FilterOnly | Description |
|---|---|---|---|---|---|
| Id [KEY] | String | True | No | The Id that YouTube uses to uniquely identify the channel, video, playlist, or asset that is included in the group. Note that this Id refers specifically to the inclusion of that entity in a particular group and is different than the channel Id, video Id, playlist Id, or asset Id that uniquely identifies the entity itself. | |
| Kind | String | False | No | Identifies the type of the group item. The value will be youtube#groupItem. | |
| Etag | String | False | No | The Etag of this item. | |
| GroupId | String | False | No | The Id that YouTube uses to uniquely identify the group that contains the item. | |
| Resource_Kind | String | False | No | The type of the group item. The allowed values are youtube#channel, youtube#playlist, youtube#video, youtubePartner#asset. | |
| Resource_Id | String | False | No | The channel, video, playlist, or asset Id that YouTube uses to uniquely identify the group item. | |
| OnBehalfOfContentOwner | String | False | No | This parameter is intended exclusively for YouTube content partners that own and manage many different YouTube channels. The OnBehalfOfContentOwner parameter indicates that the authorization credentials in the request identify a YouTube user who is acting on behalf of the content owner specified in the parameter value. |
| Name | Type | ReadOnly | References | FilterOnly | Description |
|---|---|---|---|---|---|
| Id [KEY] | String | False | No | The Id that YouTube uses to uniquely identify the group. | |
| Kind | String | False | No | Identifies the type of the YouTube Analytics entity. The value will be youtube#group. | |
| Etag | String | False | No | The Etag of this resource. | |
| Snippet_PublishedAt | DateTime | True | No | The date and time that the group was created. | |
| Snippet_Title | String | False | No | The group name. The value must be a nonempty string. | |
| ContentDetails_ItemCount | String | False | No | The number of items in the group. | |
| ContentDetails_ItemType | String | False | No | The type of entities that the group contains. The allowed values are youtube#channel, youtube#playlist, youtube#video, youtubePartner#asset. | |
| Mine | String | False | No | Set this to true to retrieve all groups owned by the authenticated user. | |
| PageToken | String | False | No | The PageToken parameter identifies a specific page in the result set that should be returned. | |
| OnBehalfOfContentOwner | String | False | No | This parameter is intended exclusively for YouTube content partners that own and manage many different YouTube channels. The OnBehalfOfContentOwner parameter indicates that the authorization credentials in the request identify a YouTube user who is acting on behalf of the content owner specified in the parameter value. |
| Name | Type | ReadOnly | References | FilterOnly | Description |
|---|---|---|---|---|---|
| Id [KEY] | String | False | No | The Id that YouTube uses to uniquely identify the i18n language. | |
| Language | String | False | No | A BCP-47 code that uniquely identifies a language. | |
| Name | String | False | No | The name of the language as it is written in that language. |
| Name | Type | ReadOnly | References | FilterOnly | Description |
|---|---|---|---|---|---|
| Id [KEY] | String | False | No | The Id that YouTube uses to uniquely identify the video. | |
| ChannelId | String | False | Channels.ID | No | The Id that YouTube uses to uniquely identify the channel that the video was uploaded to. |
| CategoryId | String | False | No | The YouTube video category associated with the video. | |
| Title | String | False | No | The title of the video. | |
| ChannelTitle | String | False | No | Channel title for the channel that the video belongs to. | |
| PublishedAt | Datetime | False | No | The date and time that the video was published. Note that this time might be different than the time that the video was uploaded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm | |
| Description | String | False | No | The description of the video. | |
| Duration | String | False | No | The length of the video. The property value is an ISO 8601 duration. | |
| ViewCount | Long | False | No | The number of times the video has been viewed. | |
| LikeCount | Long | False | No | The number of users who have indicated that they liked the video. | |
| DislikeCount | Long | False | No | The number of users who have indicated that they disliked the video. In conjunction with changes to make video dislike counts private across the entire YouTube platform, this field is returned only if the API request was authenticated by the video owner. | |
| CommentCount | Long | False | No | The number of comments for the video. | |
| EmbedHtml | String | False | No | An iframe tag that embeds a player that will play the video. | |
| PublicStatsViewable | Boolean | False | No | This value indicates whether the extended video statistics on the watch page are publicly viewable. By default, those statistics are viewable, and statistics like the viewcount and ratings will still be publicly visible even if this value is set to false. | |
| TagsAggregate | String | False | No | A list of keyword tags associated with the video. | |
| LiveBroadcastContent | String | False | No | Indicates if the video is an upcoming/active live broadcast. A value of none indicates the video is not an upcoming/active live broadcast. Valid values for this column: live, none, upcoming. | |
| Dimension | String | False | No | Indicates whether the video is available in 3D or in 2D. | |
| Definition | String | False | No | Indicates whether the video is available in high definition HD or only in standard definition. Valid values for this column: hd,sd. | |
| Caption | String | False | No | Indicates whether captions are available for the video. Valid values for this column: false, true. | |
| LicensedContent | Boolean | False | No | Indicates whether the video represents licensed content, which means that the content was uploaded to a channel linked to a YouTube content partner and then claimed by that partner. | |
| AllowedAggregate | String | False | No | A list of region codes that identify countries where the video is viewable. | |
| BlockedAggregate | String | False | No | A list of region codes that identify countries where the video is blocked. | |
| Projection | String | False | No | Specifies the projection format of the video. Valid values: 360, rectangular. | |
| PrivacyStatus | String | False | No | The privacy status of the playlist. Valid values: private, public, unlisted. | |
| MadeForKids | Boolean | False | No | This value indicates whether the video is Made For Kids. | |
| License | String | False | No | The license. Valid values: creativeCommon, youtube. | |
| Embeddable | Boolean | False | No | This value indicates whether the video can be embedded on another website. | |
| ThumbnailsDefaultUrl | String | False | No | The URL of the default image. | |
| DefaultLanguage | String | False | No | This column is confidential to trusted testers. The language of the text in the Title and Description columns. | |
| DefaultAudioLanguage | String | False | No | The default_audio_language column specifies the language spoken in the default audio track of the video. | |
| UploadStatus | String | False | No | The status of the uploaded video. Valid values for this column: deleted, failed, processed, rejected, uploaded. | |
| FailureReason | String | False | No | This value explains why a video failed to upload. This column only has a value if the UploadStatus column indicates that the upload failed. Valid values for this column: codec, conversion, emptyFile, invalidFile, tooSmall, uploadAborted. | |
| RejectionReason | String | False | No | This value explains why YouTube rejected an uploaded video. This column only has a value if the UploadStatus column indicates that the upload was rejected. Valid values for this column: claim, copyright, duplicate, inappropriate, length, termsOfUse, trademark, uploaderAccountClosed, uploaderAccountSuspended. | |
| RecordingDate | Datetime | False | No | The date and time when the video was recorded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm | |
| SearchTerms | String | False | No | The query term to search for. | |
| Region | String | False | No | The country from which to retrieve video categories. | |
| SafeSearch | String | False | Yes | Indicates whether the search results should include restricted content as well as standard content. Acceptable values: moderate, none, or strict. | |
| EventType | String | False | Yes | The eventType parameter restricts a search to broadcast events. Acceptable values are: COMPLETED, LIVE, UPCOMING. | |
| RelatedToVideoId | String | False | Yes | Retrieves a list of videos that are related to the video that the column value identifies. | |
| VideoDuration | String | False | Yes | Filters video search results based on their duration. Acceptable values: any, long, medium or short. | |
| VideoCategoryId | String | False | Yes | The videoCategoryId parameter identifies the video category for which the chart should be retrieved. | |
| ForMine | String | False | Yes | Restricts the search to only retrieve videos owned by the authenticated user. It is false by default. | |
| Language | String | False | Yes | Retrieve localized resource metadata for a specific application language that the YouTube website supports. | |
| ForContentOwner | String | False | Yes | Restricts the search to only retrieve videos owned by the content owner specified by the OnBehalfOfContentOwner parameter. | |
| OnBehalfOfContentOwner | String | False | Yes | This parameter is intended exclusively for YouTube content partners. |
| Name | Type | ReadOnly | References | FilterOnly | Description |
|---|---|---|---|---|---|
| Id [KEY] | String | False | No | The Id that YouTube uses to uniquely identify the video. | |
| ChannelId | String | False | Channels.ID | No | The Id that YouTube uses to uniquely identify the channel that the video was uploaded to. |
| CategoryId | String | False | No | The YouTube video category associated with the video. | |
| Title | String | False | No | The title of the video. | |
| ChannelTitle | String | False | No | Channel title for the channel that the video belongs to. | |
| PublishedAt | Datetime | False | No | The date and time that the video was published. Note that this time might be different than the time that the video was uploaded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm | |
| Description | String | False | No | The description of the video. | |
| Duration | String | False | No | The length of the video. The property value is an ISO 8601 duration. | |
| ViewCount | Long | False | No | The number of times the video has been viewed. | |
| LikeCount | Long | False | No | The number of users who have indicated that they liked the video. | |
| DislikeCount | Long | False | No | The number of users who have indicated that they disliked the video. In conjunction with changes to make video dislike counts private across the entire YouTube platform, this field is returned only if the API request was authenticated by the video owner. | |
| CommentCount | Long | False | No | The number of comments for the video. | |
| EmbedHtml | String | False | No | An iframe tag that embeds a player that will play the video. | |
| PublicStatsViewable | Boolean | False | No | This value indicates whether the extended video statistics on the watch page are publicly viewable. By default, those statistics are viewable, and statistics like the viewcount and ratings will still be publicly visible even if this value is set to false. | |
| TagsAggregate | String | False | No | A list of keyword tags associated with the video. | |
| LiveBroadcastContent | String | False | No | Indicates if the video is an upcoming/active live broadcast. A value of none indicates the video is not an upcoming/active live broadcast. Valid values for this column: live, none, upcoming. | |
| Dimension | String | False | No | Indicates whether the video is available in 3D or in 2D. | |
| Definition | String | False | No | Indicates whether the video is available in high definition HD or only in standard definition. Valid values for this column: hd,sd. | |
| Caption | String | False | No | Indicates whether captions are available for the video. Valid values for this column: false, true. | |
| LicensedContent | Boolean | False | No | Indicates whether the video represents licensed content, which means that the content was uploaded to a channel linked to a YouTube content partner and then claimed by that partner. | |
| AllowedAggregate | String | False | No | A list of region codes that identify countries where the video is viewable. | |
| BlockedAggregate | String | False | No | A list of region codes that identify countries where the video is blocked. | |
| Projection | String | False | No | Specifies the projection format of the video. Valid values: 360, rectangular. | |
| PrivacyStatus | String | False | No | The privacy status of the playlist. Valid values: private, public, unlisted. | |
| MadeForKids | Boolean | False | No | This value indicates whether the video is Made For Kids. | |
| License | String | False | No | The license. Valid values: creativeCommon, youtube. | |
| Embeddable | Boolean | False | No | This value indicates whether the video can be embedded on another website. | |
| ThumbnailsDefaultUrl | String | False | No | The URL of the default image. | |
| DefaultLanguage | String | False | No | This column is confidential to trusted testers. The language of the text in the Title and Description columns. | |
| DefaultAudioLanguage | String | False | No | The default_audio_language column specifies the language spoken in the default audio track of the video. | |
| UploadStatus | String | False | No | The status of the uploaded video. Valid values for this column: deleted, failed, processed, rejected, uploaded. | |
| FailureReason | String | False | No | This value explains why a video failed to upload. This column only has a value if the UploadStatus column indicates that the upload failed. Valid values for this column: codec, conversion, emptyFile, invalidFile, tooSmall, uploadAborted. | |
| RejectionReason | String | False | No | This value explains why YouTube rejected an uploaded video. This column only has a value if the UploadStatus column indicates that the upload was rejected. Valid values for this column: claim, copyright, duplicate, inappropriate, length, termsOfUse, trademark, uploaderAccountClosed, uploaderAccountSuspended. | |
| RecordingDate | Datetime | False | No | The date and time when the video was recorded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm | |
| SearchTerms | String | False | No | The query term to search for. | |
| Region | String | False | No | The country from which to retrieve video categories. | |
| SafeSearch | String | False | Yes | Indicates whether the search results should include restricted content as well as standard content. Acceptable values: moderate, none, or strict. | |
| EventType | String | False | Yes | The eventType parameter restricts a search to broadcast events. Acceptable values are: COMPLETED, LIVE, UPCOMING. | |
| RelatedToVideoId | String | False | Yes | Retrieves a list of videos that are related to the video that the column value identifies. | |
| VideoDuration | String | False | Yes | Filters video search results based on their duration. Acceptable values: any, long, medium or short. | |
| VideoCategoryId | String | False | Yes | The videoCategoryId parameter identifies the video category for which the chart should be retrieved. | |
| ForMine | String | False | Yes | Restricts the search to only retrieve videos owned by the authenticated user. It is false by default. | |
| Language | String | False | Yes | Retrieve localized resource metadata for a specific application language that the YouTube website supports. | |
| ForContentOwner | String | False | Yes | Restricts the search to only retrieve videos owned by the content owner specified by the OnBehalfOfContentOwner parameter. | |
| OnBehalfOfContentOwner | String | False | Yes | This parameter is intended exclusively for YouTube content partners. |
| Name | Type | ReadOnly | References | FilterOnly | Description |
|---|---|---|---|---|---|
| Id [KEY] | String | False | No | The Id that YouTube uses to uniquely identify the video. | |
| ChannelId | String | False | Channels.ID | No | The Id that YouTube uses to uniquely identify the channel that the video was uploaded to. |
| CategoryId | String | False | No | The YouTube video category associated with the video. | |
| Title | String | False | No | The title of the video. | |
| ChannelTitle | String | False | No | Channel title for the channel that the video belongs to. | |
| PublishedAt | Datetime | False | No | The date and time that the video was published. Note that this time might be different than the time that the video was uploaded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm | |
| Description | String | False | No | The description of the video. | |
| Duration | String | False | No | The length of the video. The property value is an ISO 8601 duration. | |
| ViewCount | Long | False | No | The number of times the video has been viewed. | |
| LikeCount | Long | False | No | The number of users who have indicated that they liked the video. | |
| DislikeCount | Long | False | No | The number of users who have indicated that they disliked the video. In conjunction with changes to make video dislike counts private across the entire YouTube platform, this field is returned only if the API request was authenticated by the video owner. | |
| CommentCount | Long | False | No | The number of comments for the video. | |
| EmbedHtml | String | False | No | An iframe tag that embeds a player that will play the video. | |
| PublicStatsViewable | Boolean | False | No | This value indicates whether the extended video statistics on the watch page are publicly viewable. By default, those statistics are viewable, and statistics like the viewcount and ratings will still be publicly visible even if this value is set to false. | |
| TagsAggregate | String | False | No | A list of keyword tags associated with the video. | |
| LiveBroadcastContent | String | False | No | Indicates if the video is an upcoming/active live broadcast. A value of none indicates the video is not an upcoming/active live broadcast. Valid values for this column: live, none, upcoming. | |
| Dimension | String | False | No | Indicates whether the video is available in 3D or in 2D. | |
| Definition | String | False | No | Indicates whether the video is available in high definition HD or only in standard definition. Valid values for this column: hd,sd. | |
| Caption | String | False | No | Indicates whether captions are available for the video. Valid values for this column: false, true. | |
| LicensedContent | Boolean | False | No | Indicates whether the video represents licensed content, which means that the content was uploaded to a channel linked to a YouTube content partner and then claimed by that partner. | |
| AllowedAggregate | String | False | No | A list of region codes that identify countries where the video is viewable. | |
| BlockedAggregate | String | False | No | A list of region codes that identify countries where the video is blocked. | |
| Projection | String | False | No | Specifies the projection format of the video. Valid values: 360, rectangular. | |
| PrivacyStatus | String | False | No | The privacy status of the playlist. Valid values: private, public, unlisted. | |
| MadeForKids | Boolean | False | No | This value indicates whether the video is Made For Kids. | |
| License | String | False | No | The license. Valid values: creativeCommon, youtube. | |
| Embeddable | Boolean | False | No | This value indicates whether the video can be embedded on another website. | |
| ThumbnailsDefaultUrl | String | False | No | The URL of the default image. | |
| DefaultLanguage | String | False | No | This column is confidential to trusted testers. The language of the text in the Title and Description columns. | |
| DefaultAudioLanguage | String | False | No | The default_audio_language column specifies the language spoken in the default audio track of the video. | |
| UploadStatus | String | False | No | The status of the uploaded video. Valid values for this column: deleted, failed, processed, rejected, uploaded. | |
| FailureReason | String | False | No | This value explains why a video failed to upload. This column only has a value if the UploadStatus column indicates that the upload failed. Valid values for this column: codec, conversion, emptyFile, invalidFile, tooSmall, uploadAborted. | |
| RejectionReason | String | False | No | This value explains why YouTube rejected an uploaded video. This column only has a value if the UploadStatus column indicates that the upload was rejected. Valid values for this column: claim, copyright, duplicate, inappropriate, length, termsOfUse, trademark, uploaderAccountClosed, uploaderAccountSuspended. | |
| RecordingDate | Datetime | False | No | The date and time when the video was recorded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm | |
| SearchTerms | String | False | No | The query term to search for. | |
| SafeSearch | String | False | Yes | Indicates whether the search results should include restricted content as well as standard content. Acceptable values: moderate, none, or strict. | |
| EventType | String | False | Yes | The eventType parameter restricts a search to broadcast events. Acceptable values are: COMPLETED, LIVE, UPCOMING. | |
| RelatedToVideoId | String | False | Yes | Retrieves a list of videos that are related to the video that the column value identifies. | |
| VideoDuration | String | False | Yes | Filters video search results based on their duration. Acceptable values: any, long, medium or short. | |
| VideoCategoryId | String | False | Yes | The videoCategoryId parameter identifies the video category for which the chart should be retrieved. | |
| ForMine | String | False | Yes | Restricts the search to only retrieve videos owned by the authenticated user. It is false by default. | |
| Language | String | False | Yes | Retrieve localized resource metadata for a specific application language that the YouTube website supports. | |
| ForContentOwner | String | False | Yes | Restricts the search to only retrieve videos owned by the content owner specified by the OnBehalfOfContentOwner parameter. | |
| OnBehalfOfContentOwner | String | False | Yes | This parameter is intended exclusively for YouTube content partners. |
| Name | Type | ReadOnly | References | FilterOnly | Description |
|---|---|---|---|---|---|
| Id [KEY] | String | False | No | The Id that YouTube uses to uniquely identify the video. | |
| ChannelId | String | False | Channels.ID | No | The Id that YouTube uses to uniquely identify the channel that the video was uploaded to. |
| CategoryId | String | False | No | The YouTube video category associated with the video. | |
| Title | String | False | No | The title of the video. | |
| ChannelTitle | String | False | No | Channel title for the channel that the video belongs to. | |
| PublishedAt | Datetime | False | No | The date and time that the video was published. Note that this time might be different than the time that the video was uploaded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm | |
| Description | String | False | No | The description of the video. | |
| Duration | String | False | No | The length of the video. The property value is an ISO 8601 duration. | |
| ViewCount | Long | False | No | The number of times the video has been viewed. | |
| LikeCount | Long | False | No | The number of users who have indicated that they liked the video. | |
| DislikeCount | Long | False | No | The number of users who have indicated that they disliked the video. In conjunction with changes to make video dislike counts private across the entire YouTube platform, this field is returned only if the API request was authenticated by the video owner. | |
| CommentCount | Long | False | No | The number of comments for the video. | |
| EmbedHtml | String | False | No | An iframe tag that embeds a player that will play the video. | |
| PublicStatsViewable | Boolean | False | No | This value indicates whether the extended video statistics on the watch page are publicly viewable. By default, those statistics are viewable, and statistics like the viewcount and ratings will still be publicly visible even if this value is set to false. | |
| TagsAggregate | String | False | No | A list of keyword tags associated with the video. | |
| LiveBroadcastContent | String | False | No | Indicates if the video is an upcoming/active live broadcast. A value of none indicates the video is not an upcoming/active live broadcast. Valid values for this column: live, none, upcoming. | |
| Dimension | String | False | No | Indicates whether the video is available in 3D or in 2D. | |
| Definition | String | False | No | Indicates whether the video is available in high definition HD or only in standard definition. Valid values for this column: hd,sd. | |
| Caption | String | False | No | Indicates whether captions are available for the video. Valid values for this column: false, true. | |
| LicensedContent | Boolean | False | No | Indicates whether the video represents licensed content, which means that the content was uploaded to a channel linked to a YouTube content partner and then claimed by that partner. | |
| AllowedAggregate | String | False | No | A list of region codes that identify countries where the video is viewable. | |
| BlockedAggregate | String | False | No | A list of region codes that identify countries where the video is blocked. | |
| Projection | String | False | No | Specifies the projection format of the video. Valid values: 360, rectangular. | |
| PrivacyStatus | String | False | No | The privacy status of the playlist. Valid values: private, public, unlisted. | |
| MadeForKids | Boolean | False | No | This value indicates whether the video is Made For Kids. | |
| License | String | False | No | The license. Valid values: creativeCommon, youtube. | |
| Embeddable | Boolean | False | No | This value indicates whether the video can be embedded on another website. | |
| ThumbnailsDefaultUrl | String | False | No | The URL of the default image. | |
| DefaultLanguage | String | False | No | This column is confidential to trusted testers. The language of the text in the Title and Description columns. | |
| DefaultAudioLanguage | String | False | No | The default_audio_language column specifies the language spoken in the default audio track of the video. | |
| UploadStatus | String | False | No | The status of the uploaded video. Valid values for this column: deleted, failed, processed, rejected, uploaded. | |
| FailureReason | String | False | No | This value explains why a video failed to upload. This column only has a value if the UploadStatus column indicates that the upload failed. Valid values for this column: codec, conversion, emptyFile, invalidFile, tooSmall, uploadAborted. | |
| RejectionReason | String | False | No | This value explains why YouTube rejected an uploaded video. This column only has a value if the UploadStatus column indicates that the upload was rejected. Valid values for this column: claim, copyright, duplicate, inappropriate, length, termsOfUse, trademark, uploaderAccountClosed, uploaderAccountSuspended. | |
| RecordingDate | Datetime | False | No | The date and time when the video was recorded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm | |
| SearchTerms | String | False | No | The query term to search for. | |
| SafeSearch | String | False | Yes | Indicates whether the search results should include restricted content as well as standard content. Acceptable values: moderate, none, or strict. | |
| EventType | String | False | Yes | The eventType parameter restricts a search to broadcast events. Acceptable values are: COMPLETED, LIVE, UPCOMING. | |
| RelatedToVideoId | String | False | Yes | Retrieves a list of videos that are related to the video that the column value identifies. | |
| VideoDuration | String | False | Yes | Filters video search results based on their duration. Acceptable values: any, long, medium or short. | |
| VideoCategoryId | String | False | Yes | The videoCategoryId parameter identifies the video category for which the chart should be retrieved. | |
| ForMine | String | False | Yes | Restricts the search to only retrieve videos owned by the authenticated user. It is false by default. | |
| Language | String | False | Yes | Retrieve localized resource metadata for a specific application language that the YouTube website supports. | |
| ForContentOwner | String | False | Yes | Restricts the search to only retrieve videos owned by the content owner specified by the OnBehalfOfContentOwner parameter. | |
| OnBehalfOfContentOwner | String | False | Yes | This parameter is intended exclusively for YouTube content partners. |
| Name | Type | ReadOnly | References | FilterOnly | Description |
|---|---|---|---|---|---|
| OperatingSystem | String | False | No | This dimension identifies the software system of the device on which the view occurred. The allowed values are ANDROID, BADA, BLACKBERRY, DOCOMO, HIPTOP, IOS, LINUX, MACINTOSH, MEEGO, NINTENDO_3DS, OTHER, PLAYSTATION, PLAYSTATION_VITA, SMART_TV, SYMBIAN, WEBOS. | |
| CreatorContentType | String | False | No | This dimension identifies the type of content associated with the user activity metrics in the data row. The allowed values are LIVE_STREAM, SHORTS, STORY, VIDEO_ON_DEMAND, UNSPECIFIED. | |
| Day | String | False | No | When you use this dimension, data in the report is aggregated on a daily basis and each row contains data for one day. | |
| LiveOrOnDemand | String | False | No | This dimension indicates whether the user activity metrics in the data row are associated with views of a live broadcast. Data for this dimension is available for dates beginning April 1, 2014. The allowed values are LIVE, ON_DEMAND. | |
| SubscribedStatus | String | False | No | This dimension indicates whether the user activity metrics in the data row are associated with viewers who were subscribed to the video or playlist channel. The allowed values are SUBSCRIBED, UNSUBSCRIBED. Note that the dimension value is accurate as of the time that the user activity occurs. | |
| YoutubeProduct | String | False | No | This dimension identifies the YouTube service on which the user activity occurred. Data for this dimension is available as of July 18, 2015. The allowed values are CORE, GAMING, KIDS, UNKNOWN. | |
| Views | Double | False | No | The number of times that a video was viewed. | |
| EstimatedMinutesWatched | Double | False | No | The number of minutes that users watched videos for the specified channel, content owner, video, or playlist. | |
| AverageViewDuration | Double | False | No | The average length, in seconds, of video playbacks. As of December 13, 2021, this metric excludes looping clips traffic. In a playlist report, the metric indicates the average length, in seconds, of video playbacks that occurred in the context of a playlist. | |
| AverageTimeInPlaylist | Double | False | No | The estimated average amount of time, in minutes, that a viewer viewed videos in a playlist after the playlist was initiated. Note that this metric includes only playlist views that occurred on the web. | |
| PlaylistAverageViewDuration | Double | False | No | The estimated average length, in seconds, watched per playlist view. Note that this metric represents the average length of views of individual videos within a playlist; the averageTimeInPlaylist metric, by contrast, represents the average time each viewer spends watching the playlist as a whole. This metric includes data for playlist videos that are owned by other channels. | |
| PlaylistEstimatedMinutesWatched | Double | False | No | The number of minutes that users watched the playlist content as a part of the playlist. Watch time that occurred in other contexts?for example, watch time from views that occurred when viewers were watching the same video as part of other playlists?is not counted. This metric includes data for playlist videos that are owned by other channels. | |
| PlaylistStarts | Double | False | No | The number of times that viewers initiated playback of a playlist. Note that this metric includes only playlist views that occurred on the web. | |
| PlaylistViews | Double | False | No | The number of times that videos in the playlist were viewed in the context of that playlist. This metric includes data for playlist videos that are owned by other channels. | |
| ViewsPerPlaylistStart | Double | False | No | The average number of video views that occurred each time a playlist was initiated. | |
| Country | String | False | No | The country associated with the metrics in the report row. The dimension value is a two-letter ISO-3166-1 country code, such as US, CN (China), or FR (France). The country code ZZ is used to report metrics for which YouTube could not identify the associated country. | |
| Province | String | False | No | The U.S. state or territory associated with the metrics in the report row. The dimension value is an ISO 3166-2 code that identifies a U.S. state or the District of Columbia, such as US-MI (Michigan) or US-TX (Texas). The province code US-ZZ is used to report metrics for which YouTube could not identify the associated U.S. state. If the Province column is specified, Country must be set to US in the WHERE clause. | |
| Continent | String | False | No | (filter only) A United Nations (U.N.) statistical region code: 002 Africa, 019 Americas (Northern America, Latin America, South America, and the Caribbean), 142 Asia, 150 Europe, 009 Oceania. This dimension can only be used to filter data. | |
| SubContinent | String | False | No | (filter only) A U.N. statistical region code that identifies a geographical subregion. | |
| Video | String | False | No | The Id of a YouTube video. | |
| Playlist | String | False | No | The Id of a YouTube playlist. | |
| Group | String | False | No | (filter only) The Id of a YouTube Analytics group. | |
| ClaimedStatus | String | False | No | (only used in content owner reports) This dimension lets you indicate that the result set will only contain metrics for claimed content. The allowed value is claimed. | |
| UploaderType | String | False | No | (only used in content owner reports) This dimension lets you indicate whether the result set will contain metrics for content uploaded by the specified content owner or content uploaded by third parties, such as user-uploaded videos. The allowed values are self and thirdParty. | |
| DeviceType | String | False | No | This dimension identifies the physical form factor of the device on which the view occurred. The allowed values are DESKTOP, GAME_CONSOLE, MOBILE, TABLET, TV, UNKNOWN_PLATFORM. | |
| StartDate | Date | False | No | Start date for fetching Analytics data. | |
| EndDate | Date | False | No | End date for fetching Analytics data. | |
| Segments | String | False | Yes | Segments the data returned for your request. Either a SegmentId or a custom segment. |
| Name | Type | ReadOnly | References | FilterOnly | Description |
|---|---|---|---|---|---|
| Id [KEY] | String | False | No | The Id that YouTube uses to uniquely identify the playlist item. | |
| PublishedAt | Datetime | False | No | The date and time that the item was added to the playlist. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm | |
| ChannelId | String | False | Channels.ID | No | The Id that YouTube uses to uniquely identify the user that added the item to the playlist. |
| Title | String | False | No | The title of the item. | |
| Description | String | False | No | The description of the item. | |
| ThumbnailsDefaultUrl | String | False | No | The URL of the item. | |
| ChannelTitle | String | False | No | The channel title of the channel that the playlist item belongs to. | |
| VideoOwnerChannelTitle | String | False | No | The channel title of the channel that uploaded this video. | |
| VideoOwnerChannelId | String | False | No | The channel ID of the channel that uploaded this video. | |
| PlaylistId | String | False | PlayLists.ID | No | The Id that YouTube uses to uniquely identify the playlist that the playlist item is in. |
| Position | String | False | No | The order in which the item appears in the playlist. The value uses a zero-based index, so the first item has a position of 0, the second item has a position of 1, and so forth. | |
| ResourceIdKind | String | False | No | The kind, or type, of the referred resource. | |
| ResourceIdVideoId | String | False | Videos.ID | No | If the ResourceIdKind value of the column is youtube#video, then this column will be present and its value will contain the Id that YouTube uses to uniquely identify the video in the playlist. |
| VideoId | String | False | Videos.ID | No | The Id that YouTube uses to uniquely identify a video. To retrieve the video resource, set the Id column to this value. |
| Note | String | False | No | A user-generated note for this item. | |
| VideoOwnerPublishedAt | Datetime | False | No | The date and time that the video was published to YouTube. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm | |
| PrivacyStatus | String | False | No | The privacy status of the playlist item. | |
| OnBehalfOfContentOwner | String | False | Yes | This parameter is intended exclusively for YouTube content partners. |
| Name | Type | ReadOnly | References | FilterOnly | Description |
|---|---|---|---|---|---|
| Id [KEY] | String | False | No | The Id that YouTube uses to uniquely identify the playlist. | |
| PublishedAt | Datetime | False | No | The date and time that the playlist was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm | |
| ChannelId | String | False | Channels.ID | No | The Id that YouTube uses to uniquely identify the channel that published the playlist. |
| Title | String | False | No | The title of the playlist. | |
| Description | String | False | No | The description of the playlist. | |
| ThumbnailsDefaultUrl | String | False | No | The URL of the image. | |
| ChannelTitle | String | False | No | Channel title of the channel that the video belongs to. | |
| DefaultLanguage | String | False | No | This column is confidential to trusted testers. The language of the text in the Title and Description columns. | |
| LocalizedTitle | String | False | No | This column is confidential to trusted testers. The localized playlist title. | |
| LocalizedDescription | String | False | No | This column is confidential to trusted testers. The localized playlist description. | |
| PrivacyStatus | String | False | No | The privacy status of the playlist. Valid values for this column: private, public, unlisted. | |
| VideoCount | Integer | False | No | The number of videos in the playlist. | |
| EmbedHtml | String | False | No | An iframe tag that embeds a player that will play the playlist. | |
| SearchTerms | String | False | No | The SearchTerms parameter specifies the query term to search for. | |
| Language | String | False | Yes | A value of hl instructs the API to retrieve localized resource metadata for a specific application language that the YouTube supports. | |
| OnBehalfOfContentOwner | String | False | Yes | This parameter is intended exclusively for YouTube content partners. | |
| OnBehalfOfContentOwnerChannel | String | False | Yes | Specifies the YouTube channel Id of the channel to which a video is being added. | |
| ForContentOwner | String | False | Yes | Restricts the search to only retrieve playlists owned by the content owner specified by the OnBehalfOfContentOwner column. | |
| Region | String | False | Yes | Instructs the API to return search results for the specified country. | |
| SafeSearch | String | False | Yes | Indicates whether the search results should include restricted content as well as standard content. Valid values: moderate, none, or strict. | |
| Rating | String | False | Yes | Specifies that playlists are sorted from highest to lowest rating. |
| Name | Type | ReadOnly | References | FilterOnly | Description |
|---|---|---|---|---|---|
| Id [KEY] | String | False | No | The Id that YouTube uses to uniquely identify the i18n region. | |
| Country | String | False | No | The two-letter ISO country code that identifies the region. | |
| Name | String | False | No | The name of the region. | |
| Language | String | False | Yes | The hl parameter specifies the language that should be used for text values in the API response. The default value is en_US. |
| Name | Type | ReadOnly | References | FilterOnly | Description |
|---|---|---|---|---|---|
| Id [KEY] | String | False | No | The Id that YouTube uses to uniquely identify the subscription. | |
| PublishedAt | Datetime | False | No | The date and time that the subscription was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm | |
| ChannelTitle | String | False | No | The title of the channel that the subscription belongs to. | |
| Title | String | False | No | The title of the subscription. | |
| Description | String | False | No | The details of the subscription. | |
| ResourceIdKind | String | False | No | The type of the API resource. | |
| ResourceIdChannelId | String | False | Channels.ID | No | The value that YouTube uses to uniquely identify the channel that the user subscribed to. |
| ChannelId | String | False | Channels.ID | No | The Id that YouTube uses to uniquely identify the channel of the subscriber. |
| ThumbnailsDefaultUrl | String | False | No | The URL of the default image. | |
| TotalItemCount | Integer | False | No | The approximate number of items that the subscription points to. | |
| NewItemCount | Integer | False | No | The number of new items in the subscription since its content was last read. | |
| ActivityType | String | False | No | The type of activity this subscription is for. Valid values: all, uploads. | |
| SubscriberTitle | String | False | No | The title of the channel of the subscriber. | |
| SubscriberDescription | String | False | No | The description of the channel of the subscriber. | |
| SubscriberChannelId | String | False | No | The Id that YouTube assigns to uniquely identify the channel of the subscriber. | |
| SubscriberThumbnailsDefaultUrl | String | False | No | The URL of the default image. | |
| MySubscribers | String | False | Yes | Set this value of this parameter to true to retrieve a feed of the subscribers of the authenticated user. | |
| ForChannelId | String | False | Yes | The ForChannelId column specifies a comma-separated list of channel Ids. | |
| OnBehalfOfContentOwner | String | False | Yes | This column is intended exclusively for YouTube content partners. | |
| OnBehalfOfContentOwnerChannel | String | False | Yes | Specifies the YouTube ChannelId of the channel to which a video is being added. | |
| Alphabetical | String | False | Yes | Sort alphabetically | |
| Relevance | String | False | Yes | Sort by relevance. | |
| Unread | String | False | Yes | Sort by order of activity. |
| Name | Type | ReadOnly | References | FilterOnly | Description |
|---|---|---|---|---|---|
| Day | String | False | No | When you use this dimension, data in the report is aggregated on a daily basis and each row contains data for one day. | |
| Month | String | False | No | Data in the report is aggregated by calendar month. In the report, dates are listed in YYYY-MM format. Note: If your SQL query uses the Month dimension, then the StartDate and EndDate parameters must both be set to the first day of the month. | |
| CreatorContentType | String | False | No | This dimension identifies the type of content associated with the user activity metrics in the data row. The allowed values are LIVE_STREAM, SHORTS, STORY, VIDEO_ON_DEMAND, UNSPECIFIED. | |
| Views | Double | False | No | The number of times that a video was viewed. In a playlist report, the metric indicates the number of times that a video was viewed in the context of a playlist. | |
| RedViews | Double | False | No | The number of times that a video was viewed by YouTube Premium (previously known as YouTube Red) members. | |
| Comments | Double | False | No | The number of times that users commented on a video. | |
| Likes | Double | False | No | The number of times that users indicated that they liked a video by giving it a positive rating. | |
| Dislikes | Double | False | No | The number of times that users indicated that they disliked a video by giving it a negative rating. This is a core metric and is subject to the Deprecation Policy. | |
| VideosAddedToPlaylists | Double | False | No | The number of times that videos were added to the video owner playlist or other channel playlists like the Watch Later playlist. Channel uploads playlists and user watch history are not reported. This metric returns an absolute number, meaning that if a user adds a video to a playlist, removes it, and then adds it again, the metric value reflects the video being added to a playlist twice. Data for this metric is not available for dates before October 1, 2014. | |
| VideosRemovedFromPlaylists | Double | False | No | The number of times that videos were removed from the video owner playlist and other YouTube playlists like the Watch Later playlist. This metric returns an absolute number, meaning that if a user adds a video to a playlist, removes it, adds it again, and then removes it again, the metric value reflects the video being removed from a playlist twice. Data for this metric is not available for dates before October 1, 2014. | |
| Shares | Double | False | No | The number of times that users shared a video through the Share button. | |
| EstimatedMinutesWatched | Double | False | No | The number of minutes that users watched videos for the specified channel, content owner, video, or playlist. | |
| EstimatedRedMinutesWatched | Double | False | No | The number of minutes that YouTube Premium (previously known as YouTube Red) members watched a video. | |
| AverageViewDuration | Double | False | No | The average length, in seconds, of video playbacks. In a playlist report, the metric indicates the average length, in seconds, of video playbacks that occurred in the context of a playlist. | |
| AverageTimeInPlaylist | Double | False | No | The estimated average amount of time, in minutes, that a viewer viewed videos in a playlist after the playlist was initiated. | |
| AverageViewPercentage | Double | False | No | The average percentage of a video watched during a video playback. | |
| AnnotationClickThroughRate | Double | False | No | The ratio of annotations that viewers clicked to the total number of clickable annotation impressions. | |
| AnnotationCloseRate | Double | False | No | The ratio of annotations that viewers closed to the total number of annotation impressions. | |
| AnnotationImpressions | Double | False | No | The total number of annotation impressions. | |
| AnnotationClickableImpressions | Double | False | No | The number of annotations that appeared and could be clicked. | |
| AnnotationClosableImpressions | Double | False | No | The number of annotations that appeared and could be closed. | |
| AnnotationClicks | Double | False | No | The number of clicked annotations. | |
| AnnotationCloses | Double | False | No | The number of closed annotations. | |
| CardClickRate | Double | False | No | The click-through-rate for cards, which is calculated as the ratio of card clicks to card impressions. | |
| CardTeaserClickRate | Double | False | No | The click-through-rate for card teasers, which is calculated as the ratio of clicks on card teasers to the total number of card teaser impressions. | |
| CardImpressions | Double | False | No | The number of times cards were displayed. When the card panel is opened, a card impression is logged for each of the video's cards. | |
| CardTeaserImpressions | Double | False | No | The number of times that card teasers were displayed. A video view can generate multiple teaser impressions. | |
| CardClicks | Double | False | No | The number of times that cards were clicked. | |
| CardTeaserClicks | Double | False | No | The number of clicks on card teasers. Card icon clicks are attributed to the last teaser displayed to the user. | |
| SubscribersGained | Double | False | No | The number of times that users subscribed to a channel or video. | |
| SubscribersLost | Double | False | No | The number of times that users unsubscribed from a channel or video. | |
| EstimatedRevenue | Decimal | False | No | The total estimated earnings (net revenue) from all Google-sold advertising sources as well as from nonadvertising sources for the selected date range and region. Estimated earnings are subject to month-end adjustment and do not include partner-sold and partner-served advertising. | |
| EstimatedAdRevenue | Decimal | False | No | The total estimated earnings (net revenue) from all Google-sold advertising sources for the selected date range and region. Estimated earnings are subject to month-end adjustment and do not include partner-sold and partner-served advertising. | |
| GrossRevenue | Decimal | False | No | The estimated gross revenue, in USD, from all Google-sold or DoubleClick-partner-sold advertising for the selected date range and region. Gross revenue is subject to month-end adjustment and does not include partner-served advertising. Gross revenue should not be confused with earnings, or net revenue, which factors in your share of ownership and revenue-sharing agreements. | |
| EstimatedRedPartnerRevenue | Decimal | False | No | The total estimated revenue earned from YouTube Red subscriptions for the selected report dimensions. The value of the metric reflects earnings from both music and nonmusic content and is subject to month-end adjustment. | |
| MonetizedPlaybacks | Double | False | No | The number of instances when a viewer played your video and was shown at least one ad impression. A monetized playback is counted if a viewer is shown a preroll ad but quits watching the ad before your video ever starts. The expected estimated error for this figure is ?2.0%. | |
| PlaybackBasedCpm | Decimal | False | No | The estimated gross revenue per thousand playbacks. | |
| AdImpressions | Double | False | No | The number of verified ad impressions served. | |
| Cpm | Decimal | False | No | The estimated gross revenue per thousand ad impressions. | |
| PlaylistAverageViewDuration | Double | False | No | The estimated average length, in seconds, watched per playlist view. Note that this metric represents the average length of views of individual videos within a playlist; the averageTimeInPlaylist metric, by contrast, represents the average time each viewer spends watching the playlist as a whole. This metric includes data for playlist videos that are owned by other channels. | |
| PlaylistEstimatedMinutesWatched | Double | False | No | The number of minutes that users watched the playlist content as a part of the playlist. Watch time that occurred in other contexts?for example, watch time from views that occurred when viewers were watching the same video as part of other playlists?is not counted. This metric includes data for playlist videos that are owned by other channels. | |
| PlaylistSaves | Double | False | No | The net number of times that users saved a playlist. This metric returns a net change number, meaning that if a user saves a playlist, removes it from the list of saved playlists, and saves it again, the metric value reflects one playlist save being added. | |
| PlaylistStarts | Double | False | No | The number of times that viewers initiated playback of a playlist. Note that this metric includes only playlist views that occurred on the web. | |
| PlaylistViews | Double | False | No | The number of times that videos in the playlist were viewed in the context of that playlist. This metric includes data for playlist videos that are owned by other channels. | |
| ViewsPerPlaylistStart | Double | False | No | The average number of video views that occurred each time a playlist was initiated. | |
| Video | String | False | No | The Id of a YouTube video. | |
| Playlist | String | False | No | The Id of a YouTube playlist. | |
| Group | String | False | No | (filter only) The Id of a YouTube Analytics group. | |
| Country | String | False | No | The country associated with the metrics in the report row. The dimension value is a two-letter ISO-3166-1 country code, such as US, CN (China), or FR (France). The country code ZZ is used to report metrics for which YouTube could not identify the associated country. | |
| Continent | String | False | No | (filter only) A United Nations (U.N.) statistical region code. The API supports the following values: 002 Africa, 019 Americas (Northern America, Latin America, South America, and the Caribbean), 142 Asia, 150 Europe, 009 Oceania. This dimension can only be used to filter data. | |
| SubContinent | String | False | No | (filter only) A U.N. statistical region code that identifies a geographical subregion. | |
| UploaderType | String | False | No | (only used in content owner reports) This dimension lets you indicate whether a result set will contain metrics for content uploaded by the specified content owner or content uploaded by third parties, such as user-uploaded videos. The allowed values are self and thirdParty. | |
| ClaimedStatus | String | False | No | (only used in content owner reports) This dimension lets you indicate that a result set will only contain metrics for claimed content. The allowed value is claimed. | |
| Channel | String | False | No | (only used in content owner reports) The Id for a YouTube channel. The channel dimension is frequently used in content owner reports because those reports typically aggregate data for multiple channels. | |
| StartDate | Date | False | No | Start date for fetching Analytics data. | |
| EndDate | Date | False | No | End date for fetching Analytics data. | |
| Segments | String | False | Yes | Segments the data returned for your request. Either a SegmentId or a custom segment. |
| Name | Type | ReadOnly | References | FilterOnly | Description |
|---|---|---|---|---|---|
| Playlist | String | False | No | The Id of a YouTube playlist. | |
| AverageTimeInPlaylist | Double | False | No | The estimated average amount of time, in minutes, that a viewer viewed videos in a playlist after the playlist was initiated. Note that this metric includes only playlist views that occurred on the web. | |
| PlaylistAverageViewDuration | Double | False | No | The estimated average length, in seconds, watched per playlist view. Note that this metric represents the average length of views of individual videos within a playlist; the averageTimeInPlaylist metric, by contrast, represents the average time each viewer spends watching the playlist as a whole. This metric includes data for playlist videos that are owned by other channels. | |
| PlaylistEstimatedMinutesWatched | Double | False | No | The number of minutes that users watched the playlist content as a part of the playlist. Watch time that occurred in other contexts?for example, watch time from views that occurred when viewers were watching the same video as part of other playlists?is not counted. This metric includes data for playlist videos that are owned by other channels. | |
| PlaylistSaves | Double | False | No | The net number of times that users saved a playlist. This metric returns a net change number, meaning that if a user saves a playlist, removes it from the list of saved playlists, and saves it again, the metric value reflects one playlist save being added. | |
| PlaylistStarts | Double | False | No | The number of times that viewers initiated playback of a playlist. Note that this metric includes only playlist views that occurred on the web. | |
| PlaylistViews | Double | False | No | The number of times that videos in the playlist were viewed in the context of that playlist. This metric includes data for playlist videos that are owned by other channels. | |
| ViewsPerPlaylistStart | Double | False | No | The average number of video views that occurred each time a playlist was initiated. | |
| StartDate | Date | False | No | Start date for fetching Analytics data. Either a date string or a relative date (e.g., today, yesterday, or #daysAgo). | |
| EndDate | Date | False | No | End date for fetching Analytics data. Either a date string or a relative date (e.g., today, yesterday, or #daysAgo). | |
| Segments | String | False | Yes | Segments the data returned for your request. Either a SegmentId or a custom segment. |
| Name | Type | ReadOnly | References | FilterOnly | Description |
|---|---|---|---|---|---|
| Video | String | False | No | The Id of a YouTube video. | |
| CreatorContentType | String | False | No | This dimension identifies the type of content associated with the user activity metrics in the data row. The allowed values are LIVE_STREAM, SHORTS, STORY, VIDEO_ON_DEMAND, UNSPECIFIED. | |
| Views | Double | False | No | The number of times that a video was viewed. In a playlist report, the metric indicates the number of times that a video was viewed in the context of a playlist. | |
| RedViews | Double | False | No | The number of times that a video was viewed by YouTube Premium (previously known as YouTube Red) members. | |
| Comments | Double | False | No | The number of times that users commented on a video. | |
| Likes | Double | False | No | The number of times that users indicated that they liked a video by giving it a positive rating. | |
| Dislikes | Double | False | No | The number of times that users indicated that they disliked a video by giving it a negative rating. This is a core metric and is subject to the Deprecation Policy. | |
| VideosAddedToPlaylists | Double | False | No | The number of times that videos were added to the video owner playlist or other channel playlists like the Watch Later playlist. Channel uploads playlists and user watch history are not reported. This metric returns an absolute number, meaning that if a user adds a video to a playlist, removes it, and then adds it again, the metric value reflects the video being added to a playlist twice. Data for this metric is not available for dates before October 1, 2014. | |
| VideosRemovedFromPlaylists | Double | False | No | The number of times that videos were removed from the video owner playlist and other YouTube playlists like the Watch Later playlist. This metric returns an absolute number, meaning that if a user adds a video to a playlist, removes it, adds it again, and then removes it again, the metric value reflects the video being removed from a playlist twice. Data for this metric is not available for dates before October 1, 2014. | |
| Shares | Double | False | No | The number of times that users shared a video through the Share button. | |
| EstimatedMinutesWatched | Double | False | No | The number of minutes that users watched videos for the specified channel, content owner, video, or playlist. | |
| EstimatedRedMinutesWatched | Double | False | No | The number of minutes that YouTube Premium (previously known as YouTube Red) members watched a video. | |
| AverageViewDuration | Double | False | No | The average length, in seconds, of video playbacks. In a playlist report, the metric indicates the average length, in seconds, of video playbacks that occurred in the context of a playlist. | |
| AverageViewPercentage | Double | False | No | The average percentage of a video watched during a video playback. | |
| AnnotationClickThroughRate | Double | False | No | The ratio of annotations that viewers clicked to the total number of clickable annotation impressions. | |
| AnnotationCloseRate | Double | False | No | The ratio of annotations that viewers closed to the total number of annotation impressions. | |
| AnnotationImpressions | Double | False | No | The total number of annotation impressions. | |
| AnnotationClickableImpressions | Double | False | No | The number of annotations that appeared and could be clicked. | |
| AnnotationClosableImpressions | Double | False | No | The number of annotations that appeared and could be closed. | |
| AnnotationClicks | Double | False | No | The number of clicked annotations. | |
| AnnotationCloses | Double | False | No | The number of closed annotations. | |
| CardClickRate | Double | False | No | The click-through-rate for cards, which is calculated as the ratio of card clicks to card impressions. | |
| CardTeaserClickRate | Double | False | No | The click-through-rate for card teasers, which is calculated as the ratio of clicks on card teasers to the total number of card teaser impressions. | |
| CardImpressions | Double | False | No | The number of times cards were displayed. When the card panel is opened, a card impression is logged for each of the video's cards. | |
| CardTeaserImpressions | Double | False | No | The number of times that card teasers were displayed. A video view can generate multiple teaser impressions. | |
| CardClicks | Double | False | No | The number of times that cards were clicked. | |
| CardTeaserClicks | Double | False | No | The number of clicks on card teasers. Card icon clicks are attributed to the last teaser displayed to the user. | |
| SubscribersGained | Double | False | No | The number of times that users subscribed to a channel or video. | |
| SubscribersLost | Double | False | No | The number of times that users unsubscribed from a channel or video. | |
| EstimatedRevenue | Decimal | False | No | The total estimated earnings (net revenue) from all Google-sold advertising sources as well as from nonadvertising sources for the selected date range and region. Estimated earnings are subject to month-end adjustment and do not include partner-sold and partner-served advertising. | |
| EstimatedAdRevenue | Decimal | False | No | The total estimated earnings (net revenue) from all Google-sold advertising sources for the selected date range and region. Estimated earnings are subject to month-end adjustment and do not include partner-sold and partner-served advertising. | |
| GrossRevenue | Decimal | False | No | The estimated gross revenue, in USD, from all Google-sold or DoubleClick-partner-sold advertising for the selected date range and region. Gross revenue is subject to month-end adjustment and does not include partner-served advertising. Gross revenue should not be confused with earnings, or net revenue, which factors in your share of ownership and revenue-sharing agreements. | |
| EstimatedRedPartnerRevenue | Decimal | False | No | The total estimated revenue earned from YouTube Red subscriptions for the selected report dimensions. The value of the metric reflects earnings from both music and nonmusic content and is subject to month-end adjustment. | |
| MonetizedPlaybacks | Double | False | No | The number of instances when a viewer played your video and was shown at least one ad impression. A monetized playback is counted if a viewer is shown a preroll ad but quits watching the ad before your video ever starts. The expected estimated error for this figure is ?2.0%. | |
| PlaybackBasedCpm | Decimal | False | No | The estimated gross revenue per thousand playbacks. | |
| AdImpressions | Double | False | No | The number of verified ad impressions served. | |
| Cpm | Decimal | False | No | The estimated gross revenue per thousand ad impressions. | |
| Channel | String | False | No | (only used in content owner reports) The Id for a YouTube channel. The channel dimension is frequently used in content owner reports because those reports typically aggregate data for multiple channels. | |
| UploaderType | String | False | No | (only used in content owner reports) This dimension lets you indicate whether a result set will contain metrics for content uploaded by the specified content owner or content uploaded by third parties, such as user-uploaded videos. The allowed values are self and thirdParty. | |
| ClaimedStatus | String | False | No | (only used in content owner reports) This dimension lets you indicate that a result set will only contain metrics for claimed content. The allowed value is claimed. | |
| SubscribedStatus | String | False | No | This dimension indicates whether the user activity metrics in the data row are associated with viewers who were subscribed to the video or playlist channel. Possible values are SUBSCRIBED and UNSUBSCRIBED. Note that the dimension value is accurate as of the time that the user activity occurs. | |
| Country | String | False | No | The country associated with the metrics in the report row. The dimension value is a two-letter ISO-3166-1 country code, such as US, CN (China), or FR (France). The country code ZZ is used to report metrics for which YouTube could not identify the associated country. | |
| Continent | String | False | No | (filter only) A United Nations (U.N.) statistical region code. The API supports the following values: 002 Africa, 019 Americas (Northern America, Latin America, South America, and the Caribbean), 142 Asia, 150 Europe, 009 Oceania. This dimension can only be used to filter data. | |
| SubContinent | String | False | No | (filter only) A U.N. statistical region code that identifies a geographical subregion. | |
| StartDate | Date | False | No | Start date for fetching Analytics data. Either a date string or a relative date (e.g., today, yesterday, or #daysAgo). | |
| EndDate | Date | False | No | End date for fetching Analytics data. Either a date string or a relative date (e.g., today, yesterday, or #daysAgo). | |
| Segments | String | False | Yes | Segments the data returned for your request. Either a SegmentId or a custom segment. |
| Name | Type | ReadOnly | References | FilterOnly | Description |
|---|---|---|---|---|---|
| InsightTrafficSourceType | String | False | No | Data in the report is aggregated based on the referrer type, which describes the manner in which users reached the video. The allowed values are ADVERTISING, ANNOTATION, EXT_URL, NO_LINK_EMBEDDED, NO_LINK_OTHER, NOTIFICATION, PLAYLIST, PROMOTED, RELATED_VIDEO, SUBSCRIBER, YT_CHANNEL, YT_OTHER_PAGE, YT_SEARCH. | |
| CreatorContentType | String | False | No | This dimension identifies the type of content associated with the user activity metrics in the data row. The allowed values are LIVE_STREAM, SHORTS, STORY, VIDEO_ON_DEMAND, UNSPECIFIED. | |
| Day | String | False | No | When you use this dimension, data in the report is aggregated on a daily basis and each row contains data for one day. | |
| LiveOrOnDemand | String | False | No | This dimension indicates whether the user activity metrics in the data row are associated with views of a live broadcast. Data for this dimension is available for dates beginning April 1, 2014. The allowed values are LIVE, ON_DEMAND. | |
| SubscribedStatus | String | False | No | This dimension indicates whether the user activity metrics in the data row are associated with viewers who were subscribed to the video or playlist channel. The allowed values are SUBSCRIBED, UNSUBSCRIBED. Note that the dimension value is accurate as of the time that the user activity occurs. | |
| Views | Double | False | No | The number of times that a video was viewed. In a playlist report, the metric indicates the number of times that a video was viewed in the context of a playlist. | |
| EstimatedMinutesWatched | Double | False | No | The number of minutes that users watched videos for the specified channel, content owner, video, or playlist. | |
| AverageViewDuration | Double | False | No | The average length, in seconds, of video playbacks. As of December 13, 2021, this metric excludes looping clips traffic. In a playlist report, the metric indicates the average length, in seconds, of video playbacks that occurred in the context of a playlist. | |
| AverageTimeInPlaylist | Double | False | No | The estimated average amount of time, in minutes, that a viewer viewed videos in a playlist after the playlist was initiated. Note that this metric includes only playlist views that occurred on the web. | |
| PlaylistAverageViewDuration | Double | False | No | The estimated average length, in seconds, watched per playlist view. Note that this metric represents the average length of views of individual videos within a playlist; the averageTimeInPlaylist metric, by contrast, represents the average time each viewer spends watching the playlist as a whole. This metric includes data for playlist videos that are owned by other channels. | |
| PlaylistEstimatedMinutesWatched | Double | False | No | The number of minutes that users watched the playlist content as a part of the playlist. Watch time that occurred in other contexts?for example, watch time from views that occurred when viewers were watching the same video as part of other playlists?is not counted. This metric includes data for playlist videos that are owned by other channels. | |
| PlaylistSaves | Double | False | No | The net number of times that users saved a playlist. This metric returns a net change number, meaning that if a user saves a playlist, removes it from the list of saved playlists, and saves it again, the metric value reflects one playlist save being added. | |
| PlaylistStarts | Double | False | No | The number of times that viewers initiated playback of a playlist. Note that this metric includes only playlist views that occurred on the web. | |
| PlaylistViews | Double | False | No | The number of times that videos in the playlist were viewed in the context of that playlist. This metric includes data for playlist videos that are owned by other channels. | |
| ViewsPerPlaylistStart | Double | False | No | The average number of video views that occurred each time a playlist was initiated. | |
| Country | String | False | No | The country associated with the metrics in the report row. The dimension value is a two-letter ISO-3166-1 country code, such as US, CN (China), or FR (France). The country code ZZ is used to report metrics for which YouTube could not identify the associated country. | |
| Province | String | False | No | The U.S. state or territory associated with the metrics in the report row. The dimension value is an ISO 3166-2 code that identifies a U.S. state or the District of Columbia, such as US-MI (Michigan) or US-TX (Texas). The province code US-ZZ is used to report metrics for which YouTube could not identify the associated U.S. state. If the Province column is specified, Country must be set to US in the WHERE clause. | |
| Continent | String | False | No | (filter only) A United Nations (U.N.) statistical region code. The allowed values are 002 Africa, 019 Americas (Northern America, Latin America, South America, and the Caribbean), 142 Asia, 150 Europe, 009 Oceania. This dimension can only be used to filter data. | |
| SubContinent | String | False | No | (filter only) A U.N. statistical region code that identifies a geographical subregion. | |
| Video | String | False | No | The Id of a YouTube video. | |
| Playlist | String | False | No | The Id of a YouTube playlist. | |
| Group | String | False | No | (filter only) The Id of a YouTube Analytics group. | |
| Channel | String | False | No | (only used in content owner reports) The Id for a YouTube channel. The channel dimension is frequently used in content owner reports because those reports typically aggregate data for multiple channels. | |
| UploaderType | String | False | No | (only used in content owner reports) This dimension lets you indicate whether a result set will contain metrics for content uploaded by the specified content owner or content uploaded by third parties, such as user-uploaded videos. The allowed values are self and thirdParty. | |
| ClaimedStatus | String | False | No | (only used in content owner reports) This dimension lets you indicate that a result set will only contain metrics for claimed content. The allowed value is claimed. | |
| StartDate | Date | False | No | Start date for fetching Analytics data. | |
| EndDate | Date | False | No | End date for fetching Analytics data. | |
| Segments | String | False | Yes | Segments the data returned for your request. Either a SegmentId or a custom segment. |
| Name | Type | ReadOnly | References | FilterOnly | Description |
|---|---|---|---|---|---|
| City | String | False | No | The estimated city associated with the metrics in the report row. Data for this dimension is available for dates beginning January 1, 2022. | |
| CreatorContentType | String | False | No | This dimension identifies the type of content associated with the user activity metrics in the data row. The allowed values are LIVE_STREAM, SHORTS, STORY, VIDEO_ON_DEMAND, UNSPECIFIED. | |
| Country | String | False | No | The country associated with the metrics in the report row. The dimension value is a two-letter ISO-3166-1 country code, such as US, CN (China), or FR (France). The country code ZZ is used to report metrics for which YouTube could not identify the associated country. | |
| Province | String | False | No | The U.S. state or territory associated with the metrics in the report row. The dimension value is an ISO 3166-2 code that identifies a U.S. state or the District of Columbia, such as US-MI (Michigan) or US-TX (Texas). The province code US-ZZ is used to report metrics for which YouTube could not identify the associated U.S. state. If the Province column is specified, Country must be set to US in the WHERE clause. | |
| SubscribedStatus | String | False | No | This dimension indicates whether the user activity metrics in the data row are associated with viewers who were subscribed to the video or playlist channel. The allowed values are SUBSCRIBED, UNSUBSCRIBED. Note that the dimension value is accurate as of the time that the user activity occurs. | |
| Day | String | False | No | When you use this dimension, data in the report is aggregated on a daily basis and each row contains data for one day. | |
| Month | String | False | No | Data in the report is aggregated by calendar month. In the report, dates are listed in YYYY-MM format. Note: If your SQL query uses the Month dimension, then the StartDate and EndDate parameters must both be set to the first day of the month. | |
| Views | Double | False | No | The number of times that a video was viewed. In a playlist report, the metric indicates the number of times that a video was viewed in the context of a playlist. | |
| EstimatedMinutesWatched | Double | False | No | The number of minutes that users watched videos for the specified channel, content owner, video, or playlist. | |
| AverageViewDuration | Double | False | No | The average length, in seconds, of video playbacks. As of December 13, 2021, this metric excludes looping clips traffic. In a playlist report, the metric indicates the average length, in seconds, of video playbacks that occurred in the context of a playlist. | |
| AverageViewPercentage | Double | False | No | The average percentage of a video watched during a video playback. As of December 13, 2021, this metric excludes looping clips traffic. | |
| Channel | String | False | No | (only used in content owner reports) The Id for a YouTube channel. The channel dimension is frequently used in content owner reports because those reports typically aggregate data for multiple channels. | |
| Video | String | False | No | The Id of a YouTube video. | |
| Group | String | False | No | (filter only) The Id of a YouTube Analytics group. | |
| ClaimedStatus | String | False | No | (only used in content owner reports) This dimension lets you indicate that a result set will only contain metrics for claimed content. The allowed value is claimed. | |
| UploaderType | String | False | No | (only used in content owner reports) This dimension lets you indicate whether a result set will contain metrics for content uploaded by the specified content owner or content uploaded by third parties, such as user-uploaded videos. The allowed values are self and thirdParty. | |
| Continent | String | False | No | (filter only) A United Nations (U.N.) statistical region code. The allowed values are 002 Africa, 019 Americas (Northern America, Latin America, South America, and the Caribbean), 142 Asia, 150 Europe, 009 Oceania. This dimension can only be used to filter data. | |
| SubContinent | String | False | No | (filter only) A U.N. statistical region code that identifies a geographical subregion. | |
| StartDate | Date | False | No | Start date for fetching Analytics data. | |
| EndDate | Date | False | No | End date for fetching Analytics data. | |
| Segments | String | False | Yes | Segments the data returned for your request. Either a SegmentId or a custom segment. |
| Name | Type | ReadOnly | References | FilterOnly | Description |
|---|---|---|---|---|---|
| Country | String | False | No | The country associated with the metrics in the report row. The dimension value is a two-letter ISO-3166-1 country code, such as US, CN (China), or FR (France). The country code ZZ is used to report metrics for which YouTube could not identify the associated country. | |
| CreatorContentType | String | False | No | This dimension identifies the type of content associated with the user activity metrics in the data row. The allowed values are LIVE_STREAM, SHORTS, STORY, VIDEO_ON_DEMAND, UNSPECIFIED. | |
| Views | Double | False | No | The number of times that a video was viewed. In a playlist report, the metric indicates the number of times that a video was viewed in the context of a playlist. | |
| RedViews | Double | False | No | The number of times that a video was viewed by YouTube Premium (previously known as YouTube Red) members. | |
| Likes | Double | False | No | The number of times that users indicated that they liked a video by giving it a positive rating. | |
| Comments | Double | False | No | The number of times that users commented on a video. | |
| Dislikes | Double | False | No | The number of times that users indicated that they disliked a video by giving it a negative rating. | |
| VideosAddedToPlaylists | Double | False | No | The number of times that videos were added to any YouTube playlists. The videos could have been added to the video owner's playlist or to other channels' playlists. | |
| VideosRemovedFromPlaylists | Double | False | No | The number of times that videos were removed from any YouTube playlists. The videos could have been removed from the video owner's playlist or from other channels' playlists. | |
| Shares | Double | False | No | The number of times that users shared a video through the Share button. | |
| EstimatedMinutesWatched | Double | False | No | The number of minutes that users watched videos for the specified channel, content owner, video, or playlist. | |
| EstimatedRedMinutesWatched | Double | False | No | The number of minutes that YouTube Premium (previously known as YouTube Red) members watched a video. | |
| AverageViewDuration | Double | False | No | The average length, in seconds, of video playbacks. As of December 13, 2021, this metric excludes looping clips traffic. In a playlist report, the metric indicates the average length, in seconds, of video playbacks that occurred in the context of a playlist. | |
| AverageViewPercentage | Double | False | No | The average percentage of a video watched during a video playback. | |
| AnnotationClickThroughRate | Double | False | No | The ratio of annotations that viewers clicked to the total number of clickable annotation impressions. | |
| AnnotationCloseRate | Double | False | No | The ratio of annotations that viewers closed to the total number of annotation impressions. | |
| AnnotationImpressions | Double | False | No | The total number of annotation impressions. | |
| AnnotationClickableImpressions | Double | False | No | The number of annotations that appeared and could be clicked. | |
| AnnotationClosableImpressions | Double | False | No | The number of annotations that appeared and could be closed. | |
| AnnotationClicks | Double | False | No | The number of clicked annotations. | |
| AnnotationCloses | Double | False | No | The number of closed annotations. | |
| CardClickRate | Double | False | No | The click-through-rate for cards, which is calculated as the ratio of card clicks to card impressions. | |
| CardTeaserClickRate | Double | False | No | The click-through-rate for card teasers, which is calculated as the ratio of clicks on card teasers to the total number of card teaser impressions. | |
| CardImpressions | Double | False | No | The number of times cards were displayed. When the card panel is opened, a card impression is logged for each of the video's cards. | |
| CardTeaserImpressions | Double | False | No | The number of times that card teasers were displayed. A video view can generate multiple teaser impressions. | |
| CardClicks | Double | False | No | The number of times that cards were clicked. | |
| CardTeaserClicks | Double | False | No | The number of clicks on card teasers. Card icon clicks are attributed to the last teaser displayed to the user. | |
| SubscribersGained | Double | False | No | The number of times that users subscribed to a channel. | |
| SubscribersLost | Double | False | No | The number of times that users unsubscribed from a channel. | |
| EstimatedRevenue | Double | False | No | The total estimated net revenue from all Google-sold advertising sources as well as from non-advertising sources for the selected date range and region. | |
| EstimatedAdRevenue | Double | False | No | The total estimated net revenue from all Google-sold advertising sources for the selected date range and region. | |
| GrossRevenue | Double | False | No | The estimated gross revenue, in USD, from all Google-sold or DoubleClick-partner-sold advertising for the selected date range and region. Gross revenue is subject to month-end adjustment and does not include partner-served advertising. Gross revenue should not be confused with estimated revenue, or net revenue, which factors in your share of ownership and revenue-sharing agreements. | |
| EstimatedRedPartnerRevenue | Double | False | No | The total estimated revenue earned from YouTube Premium (previously known as YouTube Red) subscriptions for the selected report dimensions. The metric's value reflects revenue from both music and non-music content and is subject to month-end adjustment. | |
| MonetizedPlaybacks | Double | False | No | The number of instances when a viewer played your video and was shown at least one ad impression. A monetized playback is counted if a viewer is shown a preroll ad but quits watching the ad before your video ever starts. The expected estimated error for this figure is ?2.0%. | |
| PlaybackBasedCpm | Double | False | No | The estimated gross revenue per thousand playbacks. | |
| AdImpressions | Double | False | No | The number of verified ad impressions served. | |
| CPM | Double | False | No | The estimated gross revenue per thousand ad impressions. | |
| Channel | String | False | No | (only used in content owner reports) The Id for a YouTube channel. The channel dimension is frequently used in content owner reports because those reports typically aggregate data for multiple channels. | |
| Video | String | False | No | The Id of a YouTube video. | |
| Playlist | String | False | No | The Id of a YouTube playlist. | |
| Group | String | False | No | (filter only) The Id of a YouTube Analytics group. | |
| Continent | String | False | No | (filter only) A United Nations (U.N.) statistical region code. The allowed values are 002 Africa, 019 Americas (Northern America, Latin America, South America, and the Caribbean), 142 Asia, 150 Europe, 009 Oceania. This dimension can only be used to filter data. | |
| SubContinent | String | False | No | (filter only) A U.N. statistical region code that identifies a geographical subregion. | |
| StartDate | Date | False | No | Start date for fetching Analytics data. | |
| EndDate | Date | False | No | End date for fetching Analytics data. | |
| Segments | String | False | Yes | Segments the data returned for your request. Either a SegmentId or a custom segment. |
| Name | Type | ReadOnly | References | FilterOnly | Description |
|---|---|---|---|---|---|
| Province | String | False | No | The U.S. state or territory associated with the metrics in the report row. The dimension value is an ISO 3166-2 code that identifies a U.S. state or the District of Columbia, such as US-MI (Michigan) or US-TX (Texas). The province code US-ZZ is used to report metrics for which YouTube could not identify the associated U.S. state. If the Province column is specified, Country must be set to US in the WHERE clause. | |
| CreatorContentType | String | False | No | This dimension identifies the type of content associated with the user activity metrics in the data row. The allowed values are LIVE_STREAM, SHORTS, STORY, VIDEO_ON_DEMAND, UNSPECIFIED. | |
| Views | Double | False | No | The number of times that a video was viewed. In a playlist report, the metric indicates the number of times that a video was viewed in the context of a playlist. | |
| RedViews | Double | False | No | The number of times that a video was viewed by YouTube Premium (previously known as YouTube Red) members. | |
| EstimatedMinutesWatched | Double | False | No | The number of minutes that users watched videos for the specified channel, content owner, video, or playlist. | |
| EstimatedRedMinutesWatched | Double | False | No | The number of minutes that YouTube Premium (previously known as YouTube Red) members watched a video. | |
| AverageViewDuration | Double | False | No | The average length, in seconds, of video playbacks. As of December 13, 2021, this metric excludes looping clips traffic. In a playlist report, the metric indicates the average length, in seconds, of video playbacks that occurred in the context of a playlist. | |
| AverageViewPercentage | Double | False | No | The average percentage of a video watched during a video playback. | |
| AnnotationClickThroughRate | Double | False | No | The ratio of annotations that viewers clicked to the total number of clickable annotation impressions. | |
| AnnotationCloseRate | Double | False | No | The ratio of annotations that viewers closed to the total number of annotation impressions. | |
| AnnotationImpressions | Double | False | No | The total number of annotation impressions. | |
| AnnotationClickableImpressions | Double | False | No | The number of annotations that appeared and could be clicked. | |
| AnnotationClosableImpressions | Double | False | No | The number of annotations that appeared and could be closed. | |
| AnnotationClicks | Double | False | No | The number of clicked annotations. | |
| AnnotationCloses | Double | False | No | The number of closed annotations. | |
| CardClickRate | Double | False | No | The click-through-rate for cards, which is calculated as the ratio of card clicks to card impressions. | |
| CardTeaserClickRate | Double | False | No | The click-through-rate for card teasers, which is calculated as the ratio of clicks on card teasers to the total number of card teaser impressions. | |
| CardImpressions | Double | False | No | The number of times cards were displayed. When the card panel is opened, a card impression is logged for each of the video's cards. | |
| CardTeaserImpressions | Double | False | No | The number of times that card teasers were displayed. A video view can generate multiple teaser impressions. | |
| CardClicks | Double | False | No | The number of times that cards were clicked. | |
| CardTeaserClicks | Double | False | No | The number of clicks on card teasers. Card icon clicks are attributed to the last teaser displayed to the user. | |
| Country | String | False | No | The country associated with the metrics in the report row. The dimension value is a two-letter ISO-3166-1 country code, such as US, CN (China), or FR (France). The country code ZZ is used to report metrics for which YouTube could not identify the associated country. | |
| Video | String | False | No | The Id of a YouTube video. | |
| Playlist | String | False | No | The Id of a YouTube playlist. | |
| Group | String | False | No | (filter only) The Id of a YouTube Analytics group. | |
| Channel | String | False | No | (only used in content owner reports) The Id for a YouTube channel. The channel dimension is frequently used in content owner reports because those reports typically aggregate data for multiple channels. | |
| StartDate | Date | False | No | Start date for fetching Analytics data. | |
| EndDate | Date | False | No | End date for fetching Analytics data. | |
| Segments | String | False | Yes | Segments the data returned for your request. Either a SegmentId or a custom segment. |
| Name | Type | ReadOnly | References | FilterOnly | Description |
|---|---|---|---|---|---|
| Id [KEY] | String | False | No | The Id that YouTube uses to identify the reason. | |
| Label | String | False | No | The label text for the reason. | |
| SecondaryReasonsAggregate | String | False | No | A list of secondary reasons associated with the reason, if any available. There might be 0 or more. | |
| Language | String | False | Yes | The hl parameter specifies the language that should be used for text values in the API response. The default value is en_US. |
| Name | Type | ReadOnly | References | FilterOnly | Description |
|---|---|---|---|---|---|
| Id [KEY] | String | False | No | The unique identifier for the video category. | |
| ChannelId | String | False | Channels.ID | No | The YouTube channel that created the video category. |
| Title | String | False | No | The title of the video category. | |
| Assignable | Boolean | False | No | Indicates whether videos can be associated with the category. | |
| Region | String | False | No | The country from which to retrieve video categories. | |
| Language | String | False | Yes | Specifies the language that should be used for text values in the API response. The default value is en_US. |
| Name | Type | ReadOnly | References | FilterOnly | Description |
|---|---|---|---|---|---|
| Id [KEY] | String | False | No | The Id that YouTube uses to uniquely identify the video. | |
| ChannelId | String | False | Channels.ID | No | The Id that YouTube uses to uniquely identify the channel that the video was uploaded to. |
| CategoryId | String | False | No | The YouTube video category associated with the video. | |
| Title | String | False | No | The title of the video. | |
| ChannelTitle | String | False | No | Channel title for the channel that the video belongs to. | |
| PublishedAt | Datetime | False | No | The date and time that the video was published. Note that this time might be different than the time that the video was uploaded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm | |
| Description | String | False | No | The description of the video. | |
| Duration | String | False | No | The length of the video. The property value is an ISO 8601 duration. | |
| ViewCount | Long | False | No | The number of times the video has been viewed. | |
| LikeCount | Long | False | No | The number of users who have indicated that they liked the video. | |
| DislikeCount | Long | False | No | The number of users who have indicated that they disliked the video. In conjunction with changes to make video dislike counts private across the entire YouTube platform, this field is returned only if the API request was authenticated by the video owner. | |
| CommentCount | Long | False | No | The number of comments for the video. | |
| EmbedHtml | String | False | No | An iframe tag that embeds a player that will play the video. | |
| PublicStatsViewable | Boolean | False | No | This value indicates whether the extended video statistics on the watch page are publicly viewable. By default, those statistics are viewable, and statistics like the viewcount and ratings will still be publicly visible even if this value is set to false. | |
| TagsAggregate | String | False | No | A list of keyword tags associated with the video. | |
| LiveBroadcastContent | String | False | No | Indicates if the video is an upcoming/active live broadcast. A value of none indicates the video is not an upcoming/active live broadcast. Valid values for this column: live, none, upcoming. | |
| Dimension | String | False | No | Indicates whether the video is available in 3D or in 2D. | |
| Definition | String | False | No | Indicates whether the video is available in high definition HD or only in standard definition. Valid values for this column: hd,sd. | |
| Caption | String | False | No | Indicates whether captions are available for the video. Valid values for this column: false, true. | |
| LicensedContent | Boolean | False | No | Indicates whether the video represents licensed content, which means that the content was uploaded to a channel linked to a YouTube content partner and then claimed by that partner. | |
| AllowedAggregate | String | False | No | A list of region codes that identify countries where the video is viewable. | |
| BlockedAggregate | String | False | No | A list of region codes that identify countries where the video is blocked. | |
| Projection | String | False | No | Specifies the projection format of the video. Valid values: 360, rectangular. | |
| PrivacyStatus | String | False | No | The privacy status of the playlist. Valid values: private, public, unlisted. | |
| MadeForKids | Boolean | False | No | This value indicates whether the video is Made For Kids. | |
| License | String | False | No | The license. Valid values: creativeCommon, youtube. | |
| Embeddable | Boolean | False | No | This value indicates whether the video can be embedded on another website. | |
| ThumbnailsDefaultUrl | String | False | No | The URL of the default image. | |
| DefaultLanguage | String | False | No | This column is confidential to trusted testers. The language of the text in the Title and Description columns. | |
| DefaultAudioLanguage | String | False | No | The default_audio_language column specifies the language spoken in the default audio track of the video. | |
| UploadStatus | String | False | No | The status of the uploaded video. Valid values for this column: deleted, failed, processed, rejected, uploaded. | |
| FailureReason | String | False | No | This value explains why a video failed to upload. This column only has a value if the UploadStatus column indicates that the upload failed. Valid values for this column: codec, conversion, emptyFile, invalidFile, tooSmall, uploadAborted. | |
| RejectionReason | String | False | No | This value explains why YouTube rejected an uploaded video. This column only has a value if the UploadStatus column indicates that the upload was rejected. Valid values for this column: claim, copyright, duplicate, inappropriate, length, termsOfUse, trademark, uploaderAccountClosed, uploaderAccountSuspended. | |
| RecordingDate | Datetime | False | No | The date and time when the video was recorded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm | |
| SearchTerms | String | False | No | The query term to search for. | |
| SafeSearch | String | False | Yes | Indicates whether the search results should include restricted content as well as standard content. Acceptable values: moderate, none, or strict. | |
| EventType | String | False | Yes | The eventType parameter restricts a search to broadcast events. Acceptable values are: COMPLETED, LIVE, UPCOMING. | |
| RelatedToVideoId | String | False | Yes | Retrieves a list of videos that are related to the video that the column value identifies. | |
| VideoDuration | String | False | Yes | Filters video search results based on their duration. Acceptable values: any, long, medium or short. | |
| VideoCategoryId | String | False | Yes | The videoCategoryId parameter identifies the video category for which the chart should be retrieved. | |
| Region | String | False | Yes | Instructs the API to select a video chart available in the specified region. This column can only be used in conjunction with the chart column. The parameter value is an ISO 3166-1 alpha-2 country code. | |
| ForMine | String | False | Yes | Restricts the search to only retrieve videos owned by the authenticated user. It is false by default. | |
| Chart | String | False | Yes | The chart parameter identifies the chart that you want to retrieve. Acceptable values are: mostPopular - Return the most popular videos for the specified content region and video category. | |
| Language | String | False | Yes | Retrieve localized resource metadata for a specific application language that the YouTube website supports. | |
| ForContentOwner | String | False | Yes | Restricts the search to only retrieve videos owned by the content owner specified by the OnBehalfOfContentOwner parameter. | |
| OnBehalfOfContentOwner | String | False | Yes | This parameter is intended exclusively for YouTube content partners. |