YouTube

YouTube

This document provides instructions for integrating YouTube data into Panoply. This integration uses the YouTube Analytics API.

The following items will be covered:

YouTube Data Integration

To integrate YouTube data into Panoply using default selections, complete the following steps. For more advanced options, complete the following and refer to the subsequent sections for detailed information.

  1. Click Data Sources in the navigation menu.
  2. Click the Add Data Source button.
  3. In the Data Sources – Choose Source Type window, select YouTube. YouTube is listed under APIs.
  4. In the Data Sources – YouTube screen, click Login.
  5. Select the Google account that you want to use.
  6. Click Allow to authorize Panoply to access your YouTube data.
  7. From the Channel Report dropdown menu, select either Video Reports or Playlist Reports, and then click Next.
  8. Select one or more sub-reports.
  9. Choose a date range. Available options:
    • Last 7 Days
    • Last 30 Days (default)
    • Last 3 Months
    • Last 6 Months
    • Last Year
    • Last Two Years
    • Last Three Years
  10. (Optional) To customize the ingestion from your data source, review the advanced options.
  11. Click Collect.

The Data Sources – YouTube window will appear grayed out while the data integration is pending. A small green progress bar appears below YouTube.

You will be prompted to set up the integration of another data source. You can set up multiple data integrations without impacting the ingestion of the already scheduled or pending data integrations.

From the Data Sources main menu, you can monitor the data ingestion status of the scheduled and pending data integrations. After the data ingestion is complete, you can clean or transform your data in the Tables menu.

Advanced Options

Clicking Show next to Advanced will expand the Data Sources - YouTube window to include Destination, Primary Key, Exclude, Parse string, and Truncate table.

  • Destination - Default is youtube_analytics_{__report_name}, where __report_name is the name of the YouTube Analytics report. See Data Schema for more details about each report.

  • Primary Key - Default is a dash-separated concatenation of a set of fields from each report, stored as id in the destination tables in Panoply.

Channel Report Sub-Report Fields that create the primary key
Video Reports User Video Activity by Day day (formatted as YYYY-MM-DD)
video
Video Reports User Video Activity by Country country
video
Video Reports Playback Locations day (formatted as YYYY-MM-DD)
insightplaybacklocationtype
liveorondemand
video
Video Reports Traffic Sources day (formatted as YYYY-MM-DD)
insighttrafficsourcetype
liveorondemand
video
Video Reports Device Type day (formatted as YYYY-MM-DD)
devicetype
liveorondemand
video
youtubeproduct
Video Reports Operating System day (formatted as YYYY-MM-DD)
liveorondemand
operatingsystem
video
youtubeproduct
Video Reports Viewer Demographics agegroup
gender
liveorondemand
video
Playlist Reports User Activity day field (formatted as YYYY-MM-DD)
playlist
youtubeproduct
Playlist Reports Traffic Sources day field (formatted as YYYY-MM-DD)
insighttrafficsourcetype
playlist
  • Incremental Key - By design, this data source does not include a configurable incremental key. Panoply collects data based on the date range you selected when setting up the data source.

Data Schema

Your YouTube data collected via the YouTube Analytics API is based on the report and sub-reports that you select. Each sub-report contains metrics, dimensions, and filters supported by the API. Metrics are individual measurements related to user activity, ad performance, or estimated revenue. User activity metrics include things like ratings (likes and dislikes) and video view counts. Dimensions are common criteria that are used to aggregate data, such as the date on which an action occurred or the country where the users were located.

This data source imports channel reports, either video reports or playlist reports. All tables include __updatetime, sendtime, and __report_name fields.

Video Reports

User Video Activity by Day

Default table name: youtube_analytics_channel_video_user_video_activity_by_day. The id field is a dash-separated concatenation of the date portion of the day field (formatted as YYYY-MM-DD) and video.

Field Data Type
annotationclickableimpressions number
annotationclicks number
annotationclickthroughrate number
annotationclosableimpressions number
annotationcloserate number
annotationcloses number
annotationimpressions number
averageviewduration number
averageviewpercentage number
cardclickrate number
cardclicks number
cardimpressions number
cardteaserclickrate number
cardteaserclicks number
cardteaserimpressions number
comments number
day date
dislikes number
estimatedminuteswatched number
estimatedredminuteswatched number
id text
likes number
redviews number
shares number
subscribersgained number
subscriberslost number
video text
videosaddedtoplaylists number
videosremovedfromplaylists number
views number

User Video Activity by Country

Default table name: youtube_analytics_channel_video_user_video_activity_by_country. The id field is a dash-separated concatenation of country and video.

Field Data Type
annotationclickableimpressions number
annotationclicks number
annotationclickthroughrate number
annotationclosableimpressions number
annotationcloserate number
annotationcloses number
annotationimpressions number
averageviewduration number
averageviewpercentage number
cardclickrate number
cardclicks number
cardimpressions number
cardteaserclickrate number
cardteaserclicks number
cardteaserimpressions number
comments number
country text
dislikes number
estimatedminuteswatched number
estimatedredminuteswatched number
id text
likes number
redviews number
shares number
subscribersgained number
subscriberslost number
video text
videosaddedtoplaylists number
videosremovedfromplaylists number
views number

Playback Locations

Default table name: youtube_analytics_channel_video_playback_locations. The id field is a dash-separated concatenation of the date portion of the day field (formatted as YYYY-MM-DD), insightplaybacklocationtype, liveorondemand, and video.

Field Data Type
day date
estimatedminuteswatched number
id text
insightplaybacklocationtype text
liveorondemand text
video text
views number

Traffic Sources

Default table name: youtube_analytics_channel_video_traffic_sources. The id field is a dash-separated concatenation of the date portion of the day field (formatted as YYYY-MM-DD), insighttrafficsourcetype, liveorondemand, and video.

Field Data Type
day date
estimatedminuteswatched number
id text
insighttrafficsourcetype text
liveorondemand text
video text
views number

Device Type

Default table name: youtube_analytics_channel_video_device_type. The id field is a dash-separated concatenation of the date portion of the day field (formatted as YYYY-MM-DD), devicetype, liveorondemand, video, and youtubeproduct.

Field Data Type
day date
devicetype text
estimatedminuteswatched number
id text
liveorondemand text
video text
views number
youtubeproduct text

Operating System

Default table name: youtube_analytics_channel_video_operating_system. The id field is a dash-separated concatenation of the date portion of the day field (formatted as YYYY-MM-DD), liveorondemand, operatingsystem, video, and youtubeproduct.

Field Data Type
day date
estimatedminuteswatched number
id text
liveorondemand text
operatingsystem text
video text
views number
youtubeproduct text

Viewer Demographics

Default table name: youtube_analytics_channel_video_viewer_demographics. Theid field is a dash-separated concatenation of agegroup, gender, liveorondemand, and video.

Field Data Type
agegroup text
gender text
id text
liveorondemand text
video text
viewerpercentage number

Playlist Reports

User Activity

Default table name: youtube_analytics_channel_playlist_user_activity. Theid field is a dash-separated concatenation of the date portion of the day field (formatted as YYYY-MM-DD), playlist, and youtubeproduct.

Field Data Type
averagetimeinplaylist number
averageviewduration number
day date
estimatedminuteswatched number
estimatedredminuteswatched number
id text
playlist text
playliststarts number
redviews number
views number
viewsperplayliststart number
youtubeproduct text

Traffic Sources

Default table name: youtube_analytics_channel_playlist_traffic_sources. The id field is a dash-separated concatenation of the date portion of the day field (formatted as YYYY-MM-DD), insighttrafficsourcetype, and playlist.

Field Data Type
averagetimeinplaylist number
day date
estimatedminuteswatched number
insighttrafficsourcetype text
id text
playlist text
playliststarts number
views number
viewsperplayliststart number
Getting started is easy! Get all your data in one place in minutes.
Try Free