Hide

Revision History

This page lists YouTube Analytics API changes and documentation updates. Subscribe to this changelog. Subscribe

August 20, 2015

This update contains the following changes:

  • The API documentation has been restructured in an effor to make the API easier to understand. As such, these changes do not describe new features:

    • The documentation now contains one page that lists all available channel reports and another that lists all available content owner reports. Previously, the documentation had separate pages for channel video reports, channel playlist reports, and so forth.

    • The new data model overview seeks to provide a clearer introduction to how the API works. Specifically, this document tries to better explain how YouTube uses metrics, dimensions, and filters to calculate report values.

    • The API's reports.query method, which you use to retrieve reports, is now documented separately. The information on that page had previously been on some other pages. The new page is designed to help you more easily identify the information you need to send to retrieve a report.

July 22, 2015

This update contains several changes, all of which only apply to content owners:

  • The new adEarnings metric includes total estimated earnings (net revenue) from all Google-sold advertising sources. It is not a core metric. The API supports the adEarnings metric for any report that already supported the earnings metric.

    In addition, the definition of the earnings metric has been corrected to reflect the fact that its value includes total estimated earnings from all Google-sold advertising sources as well as from non-advertising sources. Previously, the definition incorrectly indicated that the metric only included earnings from advertising sources.

  • The primaryAdGrossRevenue metric has been deprecated. Instead, use the grossRevenue metric to retrieve revenue data.

  • In addition to the deprecated primaryAdGrossRevenue metric, ad performance reports no longer support the monetizedPlaybacks and playbackBasedCpm metrics. However, several video reports do still support those metrics.

June 1, 2015

This update contains the following changes:

  • The API now supports two new metrics for video reports, videosAddedToPlaylists and videosRemovedFromPlaylists. The lists of video reports for channels and content owners have both been updated to identify the reports that support the new metrics.

    • videosAddedToPlaylists – The number of times that videos in the scope of the query were added to any YouTube playlists. The videos could have been added to the video owner's playlist or to other channels' playlists.
    • videosRemovedFromPlaylists – The number of times that videos in the scope of the query were removed from any YouTube playlists. The videos could have been removed from the video owner's playlist or from other channels' playlists.

    Both metrics include default playlists like the "Watch Later" playlist. However, they do not count playlists that a video is automatically added to, such as a channel's uploads playlist or a user's watch history. Also note that these metrics reflect the absolute number of additions and deletions. So, if a user adds a video to a playlist, then removes it, and then adds it again, the metrics indicate that the video was added to two playlists and removed from one.

    Data for these metrics is available as of October 1, 2014.

March 31, 2015

This update contains the following changes:

March 16, 2015

This update contains the following changes:

  • The new currency parameter allows you to retrieve earnings metrics in a currency other than United States dollars (USD). If the parameter is set, then the API converts values for the earnings, grossRevenue, playbackBasedCpm, and impressionBasedCpm metrics to the specified currency. The values returned are estimates calculated using exchange rates that change on a daily basis.

    The parameter value is a three-letter, ISO 4217 currency code. The default value is USD. The parameter definition contains a list of supported currency codes.

February 25, 2015

This update contains the following changes:

  • The API now supports the ability to create and manage YouTube Analytics groups as well as the ability to retrieve report data for those groups.

    • Creating and managing groups

      This update introduces the group and groupItem resources for creating and managing groups.

      • The group resource represents an Analytics group, a custom collection of up to 200 channels, videos, playlists, or assets. The API supports list, insert, update, and delete methods for this resource.
      • The groupItem resource represents an item in an Analytics group. The API supports list, insert, and delete methods for this resource.

      So, for example, you could create a group using the groups.insert method and then add items to that group using the groupItems.insert method.

    • Retrieving report data for a group

      The dimensions documentation has been updated to include the group dimension, which can be used as a filter for many channel reports and content owner reports. When you use the group filter, the API returns data for all of the items in that group. Note that the API does not currently support the ability to create reports for asset groups.

    See the YouTube Help Center for more information about YouTube Analytics groups.

February 13, 2015

This update contains the following changes:

  • The API no longer supports the show dimension.

August 28, 2014

This update contains the following changes:

  • The API now supports the ability to specify multiple values for the video, playlist, channel, and show dimensions when those dimensions are used as filters. To specify multiple values, set the filters parameter value to a comma-separated list of the video, playlist, channel, or show IDs for which the API response should be filtered. The parameter value can specify up to 200 IDs.

    If you specify multiple values for the same filter, you can also add that filter to the list of dimensions that you specify for the request. This is true even if the filter is not listed as a supported dimension for a particular report. If you do add the filter to the list of dimensions, then the API also uses the filter values to group results.

    See the filters parameter definition for complete details about this functionality.

July 16, 2014

This update contains the following changes:

  • When retrieving a channel report, you can now retrieve data for the authenticated user's channel by setting the value of the ids parameter to channel==MINE. (You can also still set the ids parameter to channel==CHANNEL_ID to retrieve data for the specified channel.)

  • The API now supports playlist reports, which contain statistics related to video views that occur in the context of a playlist. Playlist reports are available for channels and content owners.

    All playlist reports support the views and estimatedMinutesWatched metrics, and some also support the averageViewDuration metric.

    In addition, all playlist reports support the following new metrics. Note that each of these metrics only reflect playlist views that occurred on the web.

    • playlistStarts: The number of times viewers initiated playback of a playlist.
    • viewsPerPlaylistStart: The average number of video views that occurred each time a playlist was initiated.
    • averageTimeInPlaylist: The estimated average amount of time, in minutes, that a viewer viewed videos in a playlist after the playlist was initiated.

    Any request to retrieve a playlist report must use the isCurated filter, which must be set to 1 (isCurated==1).

  • The API now supports an audience retention report. This report measures a video's ability to retain its audience. The report's new elapsedVideoTimeRatio dimension measures the amount of the video that has elapsed for the corresponding metric values:

    • The audienceWatchRatio metric identifies the absolute ratio of viewers watching the video at the given point in the video. The ratio is calculated by comparing the number of times a portion of a video has been watched to the total number of views of the video.

      Note that a portion of a video could be watched more than once (or not at all) in a given video view. For example, if users rewind and watch the same portion of a video multiple times, then the absolute ratio for that portion of the video the could be greater than 1.

    • The relativeRetentionPerformance metric shows how well a video retains viewers during playbacks in comparison to all YouTube videos of similar length. A value of 0 indicates that the video retains viewers worse than any other video of similar length, while a value of 1 indicates that the video retains viewers better than any other video of similar length. A median value of 0.5 indicates that half of the videos of similar length retain viewers better while half retain viewers worse.

    You can also use the audienceType filter so that the report only returns data associated with organic views, views from TrueView in-stream ads, or views from TrueView in-display ads. (Organic views are the direct result of user action, such as a search for a video or a click on a suggested video.)

  • The API supports several new metrics related to annotations. The metrics listed below can be retrieved with any reports that previously supported the annotationClickThroughRate and annotationCloseRate metrics.

    All of the new metrics are core metrics and are subject to the Deprecation Policy. However, note that data is available for the new metrics as of July 16, 2013. (Data for the annotationClickThroughRate and annotationCloseRate metrics is available as of June 10, 2012.)

  • GOOGLE_SEARCH is no longer reported as a separate value for the insightTrafficSourceType dimension. Instead, referrals from Google search results are now attributed to the EXT_URL traffic source type. As a result, it's also no longer possible to retrieve an insightTrafficSourceDetail report that sets the insightTrafficSourceType filter to GOOGLE_SEARCH.

January 31, 2014

This update contains the following changes:

January 16, 2014

This update contains the following changes:

  • The sample requests document has been redesigned to group examples in categories, using a tab format similar to the one recently released for channel and content owner reports. With the new design, examples are grouped into the following categories:

    • Basic stats
    • Time-based
    • Geographic
    • Playback location
    • Traffic source
    • Device/OS
    • Demographic
    • Social
    • Earnings/Ads (for content owner reports only)

  • The sample requests document now includes new examples for retrieving province-specific data in either channel reports or content owner reports.

    • Province-specific metrics for U.S. states and Washington D.C.: This report retrieves a province-by-province breakdown of view counts and other statistics for a channel's videos. The data covers U.S. states and Washington D.C. The example uses the province dimension, and also uses the filters parameter to restrict the response to only include results for the United States.

    • Viewer demographics in California (age group and gender): This report retrieves statistics about the age group and gender of viewers in California who watched a channel's videos or, for content owner reports, a content owner's claimed content. This example uses the filters parameter to ensure the response only includes data for a particular province.

  • The definition of the province dimension has been updated to note that when province is included in the dimensions parameter value, the request must also restrict data to the United States by including country==US in the filters parameter value.

January 6, 2014

This update contains the following changes:

  • The documents that list the supported channel and content owner reports have been redesigned. Instead of providing a table that lists all possible reports, each document instead groups the reports into categories:

    • Basic stats
    • Time-based
    • Geographic
    • Playback location
    • Traffic source
    • Device/OS
    • Demographic
    • Social
    • Top videos

    Each document displays these categories as a list of tabs, and you can click any tab to see the supported reports in that category.

  • The API now supports three new geographic dimensions: province, continent, and subContinent.

    • The province dimension lets you retrieve statistics for U.S. states and for the District of Colombia. The API supports two uses for this dimension:

      • The API supports two reports that break statistics down on a state-by-state basis. Both reports are available for channels and content owners.

        • The core stats report provides several statistics, including view counts and estimated minutes watched.
        • The time-based report provides the same statistics, but aggregates data on a daily, 7-day, 30-day, or monthly basis.

      • You can use the filters query parameter to restrict a report to only contain statistics for a particular state. Several reports support this type of filtering, including geographic reports, playback location reports, traffic source reports, device reports, operating system reports, demographic reports, and top-video reports.

    • The continent dimension specifies a United Nations (UN) statistical region code that identifies a continent. This dimension can only be used as a filter.

    • The subContinent dimension specifies a United Nations (UN) statistical region code that identifies a sub-region of a continent. This dimension can also only be used as a filter.

      Since each sub-region is only associated with one continent, there is no need to also use the continent filter when you are using the subContinent filter. (In fact, the API will return an error if a request uses both dimensions.)

  • The documentation has been corrected so that the insightTrafficSourceDetail dimension does not include the insightTrafficSourceType value PROMOTED as a valid filter value.

September 30, 2013

This update contains the following changes:

  • The YouTube Analytics API is now subject to the Deprecation Policy described in the Terms of Service. However, the API's non-core dimensions and non-core metrics are not subject to the Deprecation Policy. The dimensions and metrics pages have been updated to list core dimensions and core metrics. In addition, the definitions on those pages have been updated to explicitly identify core dimensions and metrics.

  • The API now supports EXTERNAL_APP as a value for the insightPlaybackLocationType dimension. In conjunction with this update, as of September 10, 2013, playbacks are no longer categorized as MOBILE playbacks, though mobile playbacks that occurred before that date will still be categorized with that value.

    With this update, mobile playbacks are now classified as either WATCH, EMBEDDED, or EXTERNAL_APP playbacks, depending on the type of application where the playbacks occur.

  • The API now supports PLAYLIST as a value for the insightTrafficSourceType dimension. The value indicates that video views were referred from a playlist. Previously, these views would have been classified using the dimension's YT_OTHER_PAGE category.

July 16, 2013

This update contains the following changes:

  • The API now supports the ability to sort reports by multiple dimensions and metrics. The sample requests document contains a new example, Sorting requests by multiple dimensions/metrics, that demonstrates this functionality. The request retrieves traffic source data and has a sort parameter value of day,-views. Results are sorted chronologically, but within the result set for each day, the first row contains data for the traffic source that generated the most views, the second row contains data for the source with that generated the next highest amount of views, and so forth.

  • The API now supports two new dimensions, deviceType and operatingSystem, which can be used to retrieve data about the devices where viewers are watching your videos. The API supports reports that use either or both dimensions.

    • The deviceType report lets you retrieve view counts and estimated watch time for different types of devices, including desktop, mobile, and tablet devices. You can also use the operatingSystem filter to restrict the device type report to only contain statistics for devices running a specific operating system, such as Android or iOS.

    • The operatingSystem report lets you retrieve view counts and estimated watch time for different operating systems, such as Android, iOS, Linux, and more. You can also use the deviceType filter to restrict the operating system report to only contain statistics for a specific type of device, such as mobile devices or tablets.

    The new device type and operating system reports are available for channels and for content owners.

  • The sample requests document has been updated to include three device reports for channels and three device reports for content owners.

  • The insightPlaybackLocationType dimension may return the value YT_OTHER, which identifies views that are not classified using one of the dimension's other values.

May 23, 2013

This update contains the following changes:

  • The content owner reports document has been updated to reflect that you can sort the top video report in descending order of earnings to identify videos with the highest earnings. This report is the first one listed in the second table of the User activity and earnings reports section.

May 10, 2013

This update contains the following changes:

May 6, 2013

This update contains the following changes:

  • The API now supports the ability to retrieve watch time metrics – estimatedMinutesWatched, averageViewDuration, and averageViewPercentage – in conjunction with other metrics, including view metrics, engagement metrics, earnings metrics, and ad performance metrics.

    The lists of available channel reports and content owner reports have been updated to reflect this change. (The lists are actually shorter now since the watch time metrics can be retrieved as part of other listed reports.)

    The Sample API requests document has also been updated.

  • The reports that use the insightPlaybackLocationDetail and insightTrafficSourceDetail dimensions have been enhanced in the following ways:

    • They now support an optional country filter.

    • Content owners can now retrieve these reports using any of the following new filter combinations. Note that all of these combinations also support the optional country filter.

      • Playback location detail

        • channel,insightPlaybackLocationType==EMBEDDED
        • show,insightPlaybackLocationType==EMBEDDED
        • claimedStatus,insightPlaybackLocationType==EMBEDDED
        • uploaderType,insightPlaybackLocationType==EMBEDDED
        • uploaderType,claimedStatus,insightPlaybackLocationType==EMBEDDED

      • Traffic source detail

        • channel,insightTrafficSourceType
        • show,insightTrafficSourceType
        • claimedStatus,insightTrafficSourceType
        • uploaderType,insightTrafficSourceType
        • uploaderType,claimedStatus,insightTrafficSourceType

May 3, 2013

This update contains the following changes:

  • The new Sample API requests document provides examples that demonstrate how to retrieve many different types of reports using the YouTube Analytics API. Each example includes a brief description of the report that the request retrieves and then shows the dimensions, metrics, filters, and sort parameters for the request.

  • The insightTrafficSourceType dimension now supports SUBSCRIBER as a valid value. This value identifies video views that were referred from feeds on the YouTube homepage or from YouTube subscription features. If you filter based on this traffic source, the insightTrafficSourceDetail field will specify the homepage feed or other page from which views were referred.

March 28, 2013

This update contains the following changes:

March 21, 2013

This update contains the following changes:

  • The API now supports earnings and ad performance metrics as well as new ad performance reports. The metrics and the reports are all accessible only to YouTube content partners who participate in the YouTube Partner Program.

    • The newly supported reports support playback-based ad performance metrics and impression-based ad performance metrics. See the content owner reports documentation for more information about ad performance reports.

    • The newly supported metrics are listed below. The list of content owner reports has been updated to identify the reports, including the two new reports, that support these metrics.

      • earnings – Total estimated earnings from all Google-sold advertising sources.
      • grossRevenue – Estimated gross revenue from Google or DoubleClick partners.
      • primaryAdGrossRevenue – Estimated gross revenue, summed and classified under the primary ad type for the video playbacks that the report covers, from Google or DoubleClick partners.
      • monetizedPlaybacks – The number of playbacks that showed at least one ad impression.
      • playbackBasedCpm – Estimated gross revenue per thousand playbacks.
      • impressions – The number of verified ad impressions served.
      • impressionBasedCpm – Estimated gross revenue per thousand ad impressions.

      Note: See the metric definitions for complete details.

    • Any request that retrieves earnings or ad performance metrics must send an authorization token that grants access using the new https://www.googleapis.com/auth/yt-analytics-monetary.readonly scope.

  • The API documentation has been reorganized so that different types of reports are explained on separate pages. As such, there are now separate pages explaining the different types of channel reports and content owner reports.

February 4, 2013

This update contains the following changes:

  • The API's reference guide now has an examples section, which includes code samples that demonstrate how to call the API using the Java, JavaScript, Python, and Ruby client libraries. The JavaScript code sample is the same one discussed in detail in the sample application documentation.

November 14, 2012

This update contains the following changes:

  • The API reference guide now features the APIs Explorer, which enables you to call the API, see the API request, and retrieve real data in the response.

  • The API supports a number of new reports for both channels and content owners, which are described below. Each report is available as a channel report or a content owner report. The list of available reports has been updated to include these reports. The dimensions and metrics pages have also been updated accordingly.

    • The playback location report specifies the number of video views that took place on different types of pages or applications.

    • The playback location detail report identifies the embedded players that generated the most views for a specified video. It provides a more fine-grained view than the playback location report by identifying the URLs associated with the top embedded players.

    • The traffic source report identifies the number of videos views that originated from different types of referrers.

    • The traffic source detail report identifies the referrers that generated the most views for a specified video and a specified traffic source type. For example, this report could you the related videos that sent the most traffic to a specific video. This report is supported for several traffic sources.

    • Watch time reports provide the amount of time viewers spent watching your content. The reports can aggregate data for a specific time frame – day, previous seven days, previous 30 days, etc. – or country. If a report aggregates data by either day or country, it can also specify the average length of each video view as well as the average percentage of each video that users watched.

October 2, 2012

This update contains the following changes:

  • The YouTube Analytics API is now available to all developers. You can activate the API for your project, without having to first request access, from the Services panel in the APIs console.

  • The new Getting Started section outlines the prerequisites and basic steps for building an application that uses the YouTube Analytics API.

September 12, 2012

This update contains the following changes:

  • The new understanding quota usage section provides guidelines for optimizing your API quota usage. The API server calculates a query cost for each request, and that cost is deducted from your API usage quota. Since different types of reports may have greatly different query costs, you should plan to use your quota efficiently, and your application should only request the metrics and data that it actually needs.

  • The temporal dimensions section has been updated to explain that those dimensions indicate that an Analytics report should aggregate data based on a time period. The API now supports the following additional temporal dimensions:

    • 7DayTotals – Data in the report will be aggregated so that each row contains data for a seven-day period.
    • 30DayTotals – Data in the report will be aggregated so that each row contains data for a 30-day period.
    • month – Data in the report will be aggregated by calendar month.

    Similarly, the available reports section has been updated to reflect the API's support for reports that use these dimensions.

  • The reporting entity dimensions section has been updated to note that API requests to retrieve content owner reports must filter data using either one of these dimensions (video, channel, or show) or a supported combination of the claimedStatus and uploaderType dimensions.

  • The API now supports two new sorting options for top-video reports. These reports, which are available as channel reports or content owner reports, contain metrics (views, comments, likes, etc.) on a per-country basis and break down those metrics by video. You can now sort these reports based on the number of users who subscribed to or unsubscribed from a channel from the video's watch page.

  • The definitions of the subscribersGained and subscribersLost metrics have been updated to explain that a channel can gain or lose subscribers in several places, including the video watch page, the channel page, and the guide that appears on the YouTube home page. When these metrics appear in a video-specific report, they only include statistics from the specified video's watch page.