Field API name |
Data Type |
Description |
Use in Adriel |
30DayTotals |
string |
Data in the report is aggregated so that each row contains data for a 30-day period. In the report, the 30DayTotals column or property specifies the end date of a 30-day period. So, a row containing a day value of 2012-01-31 would contain data for the period starting January 2, 2012, and ending January 31, 2012. As with daily reports, you can use other filters to segment the data even further |
dimension |
7DayTotals |
string |
Data in the report is aggregated so that each row contains data for a seven-day period. In the report, the 7DayTotals column specifies the end date of a seven-day period. So, a row containing a day value of 2012-06-07 would contain data for the period starting June 1, 2012, and ending June 7, 2012. As with daily reports, you can use other filters to segment the data even further. |
dimension |
ageGroup |
string |
This dimension identifies the age group of the logged-in users associated with the report data. |
dimension |
annotationClickThroughRate |
float |
The ratio of annotations that viewers clicked to the total number of clickable annotation impressions. |
metric |
annotationClickableImpressions |
long |
The number of annotations that appeared and could be clicked. |
metric |
annotationClicks |
long |
The number of clicked annotations. |
metric |
annotationClosableImpressions |
long |
The number of annotations that appeared and could be closed. |
metric |
annotationCloseRate |
float |
The ratio of annotations that viewers closed to the total number of annotation impressions. |
metric |
annotationCloses |
long |
The number of closed annotations. |
metric |
annotationImpressions |
long |
The total number of annotation impressions. |
metric |
audienceWatchRatio |
float |
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. The elapsedVideoTimeRatio dimension identifies the portion of the video to which the metric corresponds. |
metric |
averageViewDuration |
long |
The average length, in seconds, of video playbacks. |
metric |
averageViewPercentage |
percentage |
The average percentage of a video watched during a video playback. |
metric |
cardClickRate |
float |
The click-through-rate for cards, which is calculated as the ratio of card clicks to card impressions. |
metric |
cardClicks |
long |
The number of times that cards were clicked. |
metric |
cardImpressions |
long |
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. |
metric |
cardTeaserClickRate |
float |
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. |
metric |
cardTeaserClicks |
long |
The number of clicks on card teasers. Card icon clicks are attributed to the last teaser displayed to the user. |
metric |
cardTeaserImpressions |
long |
The number of times that card teasers were displayed. A video view can generate multiple teaser impressions. |
metric |
channel_id |
string |
The ID that YouTube uses to uniquely identify the channel. |
dimension |
channel_title |
string |
Channel title for the channel. |
dimension |
comments |
long |
The number of times that users commented on a video. |
metric |
country |
string |
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. |
dimension |
day |
datetime |
When you use this dimension, data in the report is aggregated on a daily basis and each row contains data for one day. You can use other dimensions to break down the data even further. For example, a traffic source report can aggregate daily viewing statistics based on the manner in which users reach your videos. |
dimension |
deviceType |
string |
This dimension identifies the physical form factor of the device on which the view occurred. |
dimension |
dislikes |
long |
The number of times that users indicated that they disliked a video by giving it a negative rating. |
metric |
elapsedVideoTimeRatio |
float |
This dimension specifies the ratio of the elapsed portion of the video to the video's length. Retention dimensions and metrics are used to measure audience retention over time, and the elapsedVideoTimeRatio dimension is the time measurement. For example, a value of 0.4 indicates that the corresponding report data shows retention data after 40 percent of the video has elapsed. The API returns 100 data points for each video with ratio values ranging from 0.01 to 1.0. The times at which data is measured during video playbacks are equally spaced for each video. This means that for a two-minute video, the interval between data points is 1.2 seconds. However, for a two-hour video, the interval between data points is 72 seconds. The dimension's value denotes the exclusive end of the interval. |
dimension |
estimatedMinutesWatched |
long |
The number of minutes that users watched videos for the specified channel, content owner, video, or playlist. |
metric |
estimatedRedMinutesWatched |
long |
The number of minutes that YouTube Red members watched a video. |
metric |
gender |
string |
This dimension identifies the gender of the logged-in users associated with the report data. |
dimension |
insightPlaybackLocationType |
string |
Data in the report is aggregated based on the type of page or application where video playbacks occurred. |
dimension |
insightTrafficSourceType |
string |
Data in the report is aggregated based on the referrer type, which describes the manner in which users reached the video. Possible values for this dimension are: |
dimension |
likes |
long |
The number of times that users indicated that they liked a video by giving it a positive rating. |
metric |
liveOrOnDemand |
string |
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. |
dimension |
month |
string |
Data in the report is aggregated by calendar month. As with daily reports, you can use other filters to segment the data even further. In the report, dates are listed in YYYY-MM format. |
dimension |
redViews |
long |
The number of times that a video was viewed by YouTube Red members. |
metric |
relativeRetentionPerformance |
float |
A measurement that shows how well a video retains viewers during playbacks in comparison to all YouTube videos of similar length. The metric has a value between 0 and 1 that identifies the video's relative retention performance at a given point in the video. The point in the video is provided by the elapsedVideoTimeRatio dimension. |
metric |
shares |
long |
The number of times that users shared a video through the Share button. |
metric |
sharingService |
string |
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. |
dimension |
subscribedStatus |
string |
This dimension indicates whether the user activity metrics in the data row are associated with viewers who were subscribed to the video's or playlist's channel. Possible values are SUBSCRIBED and UNSUBSCRIBED. |
dimension |
subscribersGained |
long |
The number of times that users subscribed to a channel. |
metric |
subscribersLost |
long |
The number of times that users unsubscribed from a channel. |
metric |
video |
string |
video identifier |
dimension |
videosAddedToPlaylists |
long |
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. |
metric |
videosRemovedFromPlaylists |
long |
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. |
metric |
views |
long |
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. |
metric |
youtubeProduct |
string |
This dimension identifies the YouTube service on which the user activity occurred. Data for this dimension is available as of July 18, 2015. |
dimension |