This page identifies the different types of content owner reports that you can retrieve via the API. Also see the Sample API requests document, which provides the API queries you would use to retrieve many different reports.
Note: Content owner reports are only accessible to YouTube content partners who participate in the YouTube Partner Program.
Contents
Overview
Content owner reports aggregate metrics for all of the channels linked to a specified YouTube content owner. You can also filter content owner reports so that they only return data for a specific channel that the authenticated content owner manages.
Content owner reports fall into two general categories:
-
User activity and earnings reports
These reports support metrics that measure user activity, such as the number of views or ratings that occurred on all of a content owner's channels (or only on a specific channel or video). Several of these reports also support statistics that measure earnings and ad performance.
While activity reports and earnings reports may seem like two separate types of reports, they are grouped together here because they use the same dimensions. (Dimensions are the criteria used to aggregate data, such as the date on which user activity occurred or the country where users were located.)
-
These reports contain metrics related to revenue and ad performance, and they always use the
adType
dimension to group those metrics based on the types of ads that ran during video playbacks. The ad performance reports section explains the two types of ad performance metrics that the API supports.
To retrieve a content owner report, set the ids
parameter value in your API request to contentOwner==OWNER_NAME
, where OWNER_NAME
specifies the content owner's ID. Ask your partner manager if you are unsure of the value.
Authorization
All YouTube Analytics API requests require authorization, and the Authorization guide explains how to use the OAuth 2.0 protocol to authorize your requests. As that guide explains, when you retrieve an authorization token, you specify a list of scopes to identify the resources that your application could access on the user's behalf. (You can only retrieve the authorization token if the user grants your application the ability to access those resources.)
The YouTube Analytics API uses two authorization scopes to retrieve metrics:
Scope | Description |
---|---|
https://www.googleapis.com/auth/yt-analytics.readonly | View YouTube Analytics reports for your YouTube content. This scope provides access to user activity metrics, like view counts and rating counts. |
https://www.googleapis.com/auth/yt-analytics-monetary.readonly | View YouTube Analytics monetary reports for your YouTube content. This scope provides access to user activity metrics and to earnings and ad performance metrics. |
Important: The authorization token that your application sends for any given API request must grant access to the resources that you are requesting. Any YouTube Analytics API request that retrieves earnings or ad performance metrics must use an authorization token that grants access using the https://www.googleapis.com/auth/yt-analytics-monetary.readonly
scope.
Filters
All API requests to retrieve content owner reports must filter data using either the video
dimension, the channel
dimension, the show
dimension, or a supported combination of the claimedStatus
and uploaderType
dimensions. (Supported combinations are listed in the uploaderType
dimension's definition.)
The report descriptions in the next section identify the filters that can be used for any given report. In the descriptions, filters shown in parentheses are optional. For example, if a report lists video(,country)
as a filtering option, then the report could either be filtered to only include data for a specific video or to only include data for a specific video in a specific country.
Available reports
The sections below describe the different activity and ad performance reports that the API supports for content owners. Each description includes an overview of the report as well as a list of the report's dimensions, metrics, and filters. Some reports also identify supported sorting criteria and require you to specify a maximum number of results to return.
User activity reports
Click the panels below to see descriptions of different types of activity reports that the API supports.
Note: Metrics that are marked with an asterisk (*
) require an authorization token that grants access to the https://www.googleapis.com/auth/yt-analytics-monetary.readonly
scope.
Important: Filters listed in parentheses are optional. For example, for the filtering option claimedStatus(,uploaderType)(,country)
, the claimedStatus filter is required, and the uploaderType and country filters are both optional.
Basic user activity statistics (including subscriber counts)
This report provides statistics related to user actions on all of a content owner's channels. You can filter the report to only return data for a specific video or country. It can also be used to only retrieve statistics for claimed content, including claimed content uploaded by the content owner, third parties, or both. The report includes the subscribersGained
and subscribersLost
metrics.
Dimensions: | [None] |
---|---|
Metrics: | views, comments, favoritesAdded, favoritesRemoved, likes, dislikes, shares, estimatedMinutesWatched, averageViewDuration, averageViewPercentage, annotationClickThroughRate, annotationCloseRate, subscribersGained, subscribersLost, earnings*, grossRevenue*, monetizedPlaybacks*, playbackBasedCpm*, impressions*, impressionBasedCpm* |
Filters: |
video(,country) video(,continent) video(,subContinent) channel(,country) channel(,continent) channel(,subContinent) claimedStatus(,uploaderType)(,country) claimedStatus(,uploaderType)(,continent) claimedStatus(,uploaderType)(,subContinent) uploaderType(,country) uploaderType(,continent) uploaderType(,subContinent) |
Basic user activity statistics for shows
This report provides statistics related to user actions on a content owner's show. This report supports the show
filter, which cannot be used to retrieve subscriber counts in the report above.
Dimensions: | [None] |
---|---|
Metrics: | views, comments, favoritesAdded, favoritesRemoved, likes, dislikes, shares, estimatedMinutesWatched, averageViewDuration, averageViewPercentage, annotationClickThroughRate, annotationCloseRate, earnings*, grossRevenue*, monetizedPlaybacks*, playbackBasedCpm*, impressions*, impressionBasedCpm* |
Filters: |
show(,country) show(,continent) show(,subContinent) |
Basic user activity statistics for U.S. states
This report provides statistics for a particular U.S. state or the District of Columbia. Note that this report only supports a subset of the metrics available in the country-specific report described above.
Dimensions: | [None] |
---|---|
Metrics: | views, estimatedMinutesWatched, averageViewDuration, averageViewPercentage, annotationClickThroughRate, annotationCloseRate |
Filters: |
video,province channel,province show,province claimedStatus,province(,uploaderType) uploaderType,province |
Important: Filters listed in parentheses are optional. For example, for the filtering option claimedStatus(,uploaderType)(,country)
, the claimedStatus filter is required, and the uploaderType and country filters are both optional.
Activity for time periods (including subscriber counts)
This report provides statistics related to user actions on all of a content owner's channels for specific time intervals. You can filter the report to only return data for a specific video or country. The report includes the subscribersGained
and subscribersLost
metrics.
Dimensions: | day or 7DayTotals or 30DayTotals or month |
---|---|
Metrics: | views, comments, favoritesAdded, favoritesRemoved, likes, dislikes, shares, estimatedMinutesWatched, averageViewDuration, averageViewPercentage, annotationClickThroughRate, annotationCloseRate, subscribersGained, subscribersLost, uniques, earnings*, grossRevenue*, monetizedPlaybacks*, playbackBasedCpm*, impressions*, impressionBasedCpm* |
Filters: |
video(,country) video(,continent) video(,subContinent) channel(,country) channel(,continent) channel(,subContinent) |
User activity for specific time periods (including owned and claimed content)
This report provides statistics related to user actions on all of a content owner's content for specific time intervals. This report supports a different set of filters than the one that includes subscriber counts. It can be used to only retrieve statistics for claimed content, including claimed content uploaded by the content owner, third parties, or both.
Dimensions: | day or 7DayTotals or 30DayTotals or month |
---|---|
Metrics: | views, comments, favoritesAdded, favoritesRemoved, likes, dislikes, shares, estimatedMinutesWatched, averageViewDuration, averageViewPercentage, annotationClickThroughRate, annotationCloseRate, uniques, earnings*, grossRevenue*, monetizedPlaybacks*, playbackBasedCpm*, impressions*, impressionBasedCpm* |
Filters: |
show(,country) show(,continent) show(,subContinent) claimedStatus(,uploaderType)(,country) claimedStatus(,uploaderType)(,continent) claimedStatus(,uploaderType)(,subContinent) uploaderType(,country) uploaderType(,continent) uploaderType(,subContinent) |
User activity in U.S. states for specific time periods
This report provides statistics for a particular U.S. state or the District of Columbia. Note that this report only supports a subset of the metrics available in the country-specific report described above.
Important: Filters listed in parentheses are optional. For example, for the filtering option claimedStatus(,uploaderType)(,country)
, the claimedStatus filter is required, and the uploaderType and country filters are both optional.
User activity by country (including subscriber counts)
This report provides statistics related to user activity on a country-by-country basis for all of a content owner's channels. You can filter the report to only return data for a specific video or channel. This report includes the subscribersGained
and subscribersLost
metrics.
User activity by country (including owned and claimed content)
This report provides statistics related to user activity on a country-by-country basis for all of a content owner's channels. The report supports a different set of filters than the one that includes subscriber counts. It can be used to only retrieve statistics for claimed content, including claimed content uploaded by the content owner, third parties, or both.
User activity by province
This report provides user activity statistics for U.S. states and the District of Columbia. For this report, you must set the filters
parameter value to country==US
.
Dimensions: | province |
---|---|
Metrics: | views, estimatedMinutesWatched, averageViewDuration, averageViewPercentage, annotationClickThroughRate, annotationCloseRate |
Filters: |
video,country==US channel,country ==US show,country ==US claimedStatus,country ==US (,uploaderType)uploaderType,country ==US |
Important: Filters listed in parentheses are optional. For example, for the filtering option claimedStatus(,uploaderType)(,country)
, the claimedStatus filter is required, and the uploaderType and country filters are both optional.
Video playback location report
This report provides statistics related to the type of page or application where video playbacks occurred.
Dimensions: | insightPlaybackLocationType day,insightPlaybackLocationType |
---|---|
Metrics: | views,estimatedMinutesWatched |
Filters: |
video(,country) video(,province) video(,continent) video(,subContinent) channel(,country) channel(,province) channel(,continent) channel(,subContinent) show(,country) show(,province) show(,continent) show(,subContinent) claimedStatus(,uploaderType)(,country) claimedStatus(,uploaderType)(,province) claimedStatus(,uploaderType)(,continent) claimedStatus(,uploaderType)(,subContinent) uploaderType(,country) uploaderType(,province) uploaderType(,continent) uploaderType(,subContinent) |
Playback location detail(<= 25 results)
Note: This report requires you to set the max-results
parameter to a integer value of 25
or less. Unlike most other reports, this report also requires you to specify a value for the sort
request parameter.
This report identifies the embedded video players that generated the most views or viewing time for a content owner's content. When retrieving this report, you must set the insightPlaybackLocationType
filter to EMBEDDED
.
Important: Filters listed in parentheses are optional. For example, for the filtering option claimedStatus(,uploaderType)(,country)
, the claimedStatus filter is required, and the uploaderType and country filters are both optional.
Traffic source
This report aggregates viewing statistics based on the manner in which viewers reached your video content. For example, it identifies the number of views that stemmed from a Google search or from a link to a related video.
Dimensions: | insightTrafficSourceType day,insightTrafficSourceType |
---|---|
Metrics: | views, estimatedMinutesWatched |
Filters: |
video(,country) video(,province) video(,continent) video(,subContinent) channel(,country) channel(,province) channel(,continent) channel(,subContinent) show(,country) show(,province) show(,continent) show(,subContinent) claimedStatus(,uploaderType)(,country) claimedStatus(,uploaderType)(,province) claimedStatus(,uploaderType)(,continent) claimedStatus(,uploaderType)(,subContinent) uploaderType(,country) uploaderType(,province) uploaderType(,continent) uploaderType(,subContinent) |
Traffic source detail(<= 25 results)
Note: This report requires you to set the max-results
parameter to a integer value of 25
or less. Unlike most other reports, this report also requires you to specify a value for the sort
request parameter.
This report aggregates viewing statistics based on the referrers that generated the most views for the content owner's content. Referrers are categorized by traffic source type, and the insightTrafficSourceDetail dimension's definition identifies the traffic sources for which the report is available. For example, if you set the insightTrafficSourceType filter to GOOGLE_SEARCH
, the report will list the Google search terms that generated the most views or viewing time for the content owner's content.
Note: This report is only supported for specific traffic sources. For example, the NO_LINK_EMBEDDED
traffic source does not have additional details and, therefore, does not support this report. See the insightTrafficSourceType definition for details about which traffic sources support this report.
Important: Filters listed in parentheses are optional. For example, for the filtering option claimedStatus(,uploaderType)(,country)
, the claimedStatus filter is required, and the uploaderType and country filters are both optional.
Device type
This report aggregates viewing statistics based on the manner in which viewers reached your video content. For example, it identifies the number of views that stemmed from a Google search or from a link to a related video.
Dimensions: | deviceType day,deviceType |
---|---|
Metrics: | views, estimatedMinutesWatched |
Filters: |
video(,country)(, operatingSystem) channel(,country)(, operatingSystem) show(,country)(, operatingSystem) claimedStatus(,uploaderType)(,country)(, operatingSystem) uploaderType(,country)(, operatingSystem) video(,province)(, operatingSystem) channel(,province)(, operatingSystem) show(,province)(, operatingSystem) claimedStatus(,uploaderType)(,province)(, operatingSystem) uploaderType(,province)(, operatingSystem) video(,continent)(, operatingSystem) channel(,continent)(, operatingSystem) show(,continent)(, operatingSystem) claimedStatus(,uploaderType)(,continent)(, operatingSystem) uploaderType(,continent)(, operatingSystem) video(,subContinent)(, operatingSystem) channel(,subContinent)(, operatingSystem) show(,subContinent)(, operatingSystem) claimedStatus(,uploaderType)(,subContinent)(, operatingSystem) uploaderType(,subContinent)(, operatingSystem) |
Operating system
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.
Dimensions: | operatingSystem day,operatingSystem |
---|---|
Metrics: | views, estimatedMinutesWatched |
Filters: |
video(,country)(, deviceType) channel(,country)(, deviceType) show(,country)(, deviceType) claimedStatus(,uploaderType)(,country)(, deviceType) uploaderType(,country)(, deviceType) video(,province)(, deviceType) channel(,province)(, deviceType) show(,province)(, deviceType) claimedStatus(,uploaderType)(,province)(, deviceType) uploaderType(,province)(, deviceType) video(,continent)(, deviceType) channel(,continent)(, deviceType) show(,continent)(, deviceType) claimedStatus(,uploaderType)(,continent)(, deviceType) uploaderType(,continent)(, deviceType) video(,subContinent)(, deviceType) channel(,subContinent)(, deviceType) show(,subContinent)(, deviceType) claimedStatus(,uploaderType)(,subContinent)(, deviceType) uploaderType(,subContinent)(, deviceType) |
Operating system and device type
This report aggregates viewing statistics based on viewers' operating systems and device types. For example, it identifies the number of views that occurred on Android tablets or on Windows desktop devices.
Dimensions: | operatingSystem,deviceType day,operatingSystem,deviceType |
---|---|
Metrics: | views, estimatedMinutesWatched |
Filters: |
video(,country) video(,province) video(,continent) video(,subContinent) channel(,country) channel(,province) channel(,continent) channel(,subContinent) show(,country) show(,province) show(,continent) show(,subContinent) claimedStatus(,uploaderType)(,country) claimedStatus(,uploaderType)(,province) claimedStatus(,uploaderType)(,continent) claimedStatus(,uploaderType)(,subContinent) uploaderType(,country) uploaderType(,province) uploaderType(,continent) uploaderType(,subContinent) |
Important: Filters listed in parentheses are optional. For example, for the filtering option claimedStatus(,uploaderType)(,country)
, the claimedStatus filter is required, and the uploaderType and country filters are both optional.
Viewer demographics (age group and gender)
This report aggregates viewing statistics based on viewers' age group and gender.
Dimensions: | ageGroup,gender |
---|---|
Metrics: | viewerPercentage |
Filters: |
video(,country) video(,province) video(,continent) video(,subContinent) channel(,country) channel(,province) channel(,continent) channel(,subContinent) show(,country) show(,province) show(,continent) show(,subContinent) claimedStatus(,uploaderType)(,country) claimedStatus(,uploaderType)(,province) claimedStatus(,uploaderType)(,continent) claimedStatus(,uploaderType)(,subContinent) uploaderType(,country) uploaderType(,province) uploaderType(,continent) uploaderType(,subContinent) |
Important: Filters listed in parentheses are optional. For example, for the filtering option claimedStatus(,uploaderType)(,country)
, the claimedStatus filter is required, and the uploaderType and country filters are both optional.
Content sharing by platform
This report provides statistics showing how frequently the channel's videos were shared on different social platforms.
Dimensions: | sharingService |
---|---|
Metrics: | shares |
Filters: |
video(,country) video(,continent) video(,subContinent) channel(,country) channel(,continent) channel(,subContinent) show(,country) show(,continent) show(,subContinent) claimedStatus(,uploaderType)(,country) claimedStatus(,uploaderType)(,continent) claimedStatus(,uploaderType)(,subContinent) uploaderType(,country) uploaderType(,continent) uploaderType(,subContinent) |
Important: Filters listed in parentheses are optional. For example, for the filtering option claimedStatus(,uploaderType)(,country)
, the claimedStatus filter is required, and the uploaderType and country filters are both optional.
Note: These reports require you to set the max-results
parameter to an integer value of 10
or less. Unlike most other reports, these reports also require you to specify a value for the sort
request parameter.
Top videos overall, by country, by continent, or by subcontinent (<= 10 results)
This report lists the content owner's top videos based on the specified filtering and sorting criteria.
Dimensions: | video |
---|---|
Metrics: | views, comments, favoritesAdded, favoritesRemoved, likes, dislikes, shares, estimatedMinutesWatched, averageViewDuration, averageViewPercentage, annotationClickThroughRate, annotationCloseRate, subscribersGained, subscribersLost |
Filters: |
channel(,country) claimedStatus(,uploaderType)(,country) uploaderType(,country) channel(,continent) claimedStatus(,uploaderType)(,continent) uploaderType(,continent) channel(,subContinent) claimedStatus(,uploaderType)(,subContinent) uploaderType(,subContinent) |
Sorting options: |
-views -earnings -estimatedMinutesWatched -subscribersGained -subscribersLost |
Top videos overall, by country, by continent, or by subcontinent (<= 10 results)
This report lists the content owner's top videos in a particular U.S. state or the District of Columbia. Note that this report only supports a subset of the metrics available in the country-specific report described above.
Dimensions: | video |
---|---|
Metrics: | views, estimatedMinutesWatched, averageViewDuration, averageViewPercentage, annotationClickThroughRate, annotationCloseRate |
Filters: |
channel(,province) claimedStatus(,uploaderType)(,province) uploaderType(,province) |
Sorting options: |
-views -earnings -estimatedMinutesWatched -subscribersGained -subscribersLost |
Ad performance reports
Note: Ad performance reports require an authorization token that grants access to the https://www.googleapis.com/auth/yt-analytics-monetary.readonly
scope.
Ad performance reports aggregate metrics based on the types of ads that ran during video playbacks. The API returns two types of ad performance metrics:
-
Playback-based ad performance metrics group data based on the primary type of ad shown during a video playback. A single video playback may result in multiple ad impressions, and the primary ad type is typically the one that generates the most revenue.
Playback-based ad performance metrics are:
-
Impression-based ad performance metrics group information based on ad types. Since these metrics account for each ad impression, they do not have a notion of a primary ad type.
Impression-based ad performance metrics are:
Ad performance reports (supported parameters)
Dimensions: | adType |
---|---|
Metrics: | grossRevenue, primaryAdGrossRevenue, monetizedPlaybacks, playbackBasedCpm, impressions, impressionBasedCpm |
Filters: |
country continent subContinent video(,country) video(,continent) video(,subContinent) show(,country) show(,continent) show(,subContinent) claimedStatus(,uploaderType)(,country) claimedStatus(,uploaderType)(,continent) claimedStatus(,uploaderType)(,subContinent) uploaderType(,country) uploaderType(,continent) uploaderType(,subContinent) |