TrafficSources

Columns

Name

Type

Dimension

DefaultMetric

DefaultDimension

Description

Channel

String

True

(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

True

The Id of a YouTube video.

Playlist

String

True

The Id of a YouTube playlist.

Group

String

True

(filter only) The Id of a YouTube Analytics group.

Country

String

True

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

True

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

True

(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

(filter only) A U.N. statistical region code that identifies a geographical subregion.

Day

String

True

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

True

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, ONDEMAND.

SubscribedStatus

String

True

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.

InsightTrafficSourceType

String

True

True

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.

InsightTrafficSourceDetail

String

True

Details about the InsightTrafficSourceType.

IsCurated

Boolean

True

This filter indicates that the request is retrieving data about video views that occurred in the context of a playlist. This filter is required for any playlist report and its value must be set to 1.

ClaimedStatus

String

True

(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

True

(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.

Views

Double

False

True

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

True

The number of minutes that users watched videos for the specified channel, content owner, video, or playlist.

PlaylistStarts

Double

False

False

The number of times that viewers initiated playback of a playlist.

ViewsPerPlaylistStart

Double

False

False

The average number of video views that occurred each time a playlist was initiated.

AverageTimeInPlaylist

Double

False

False

The estimated average amount of time, in minutes, that a viewer viewed videos in a playlist after the playlist was initiated.

StartDate

Date

Start date for fetching Analytics data.

EndDate

Date

End date for fetching Analytics data.

Pseudo-Columns

Name

Type

Description

Segments

String

Segments the data returned for your request. Either a SegmentId or a custom segment.

Last updated