EndPoint Get report
Name
get_report
Description
No description available
[API Help]
Parameters
| Parameter |
Label |
Required |
Options |
Description |
| ids |
ids |
YES |
| Option |
Value |
| Filter1 |
channel==MINE |
| Filter2 |
channel==ENTER_CHANNEL_ID |
| Filter3 |
contentOwner==ENTER_OWNER_NAME |
|
|
| metrics |
metrics |
YES |
| Option |
Value |
| adEarnings |
adEarnings |
| annotationImpressions |
annotationImpressions |
| annotationClickableImpressions |
annotationClickableImpressions |
| annotationClicks |
annotationClicks |
| annotationClickThroughRate |
annotationClickThroughRate |
| annotationClosableImpressions |
annotationClosableImpressions |
| annotationCloses |
annotationCloses |
| annotationCloseRate |
annotationCloseRate |
| audienceWatchRatio |
audienceWatchRatio |
| averageViewDuration |
averageViewDuration |
| averageViewPercentage |
averageViewPercentage |
| cardClickRate |
cardClickRate |
| cardClicks |
cardClicks |
| cardImpressions |
cardImpressions |
| cardTeaserClickRate |
cardTeaserClickRate |
| cardTeaserClicks |
cardTeaserClicks |
| cardTeaserImpressions |
cardTeaserImpressions |
| comments |
comments |
| dislikes |
dislikes |
| earnings |
earnings |
| estimatedMinutesWatched |
estimatedMinutesWatched |
| estimatedPartnerAdSenseRevenue |
estimatedPartnerAdSenseRevenue |
| estimatedPartnerDoubleClickRevenue |
estimatedPartnerDoubleClickRevenue |
| grossRevenue |
grossRevenue |
| impressionBasedCpm |
impressionBasedCpm |
| impressions |
impressions |
| likes |
likes |
| monetizedPlaybacks |
monetizedPlaybacks |
| playbackBasedCpm |
playbackBasedCpm |
| playlistStarts |
playlistStarts |
| savesAdded |
savesAdded |
| savesRemoved |
savesRemoved |
| shares |
shares |
| subscribersGained |
subscribersGained |
| subscribersLost |
subscribersLost |
| videosAddedToPlaylists |
videosAddedToPlaylists |
| videosRemovedFromPlaylists |
videosRemovedFromPlaylists |
| viewerPercentage |
viewerPercentage |
| views |
views |
|
|
| startDate |
Start Date (yyyy-MM-dd) |
YES |
| Option |
Value |
| today |
today |
| yesterday |
yesterday |
| monthstart |
monthstart |
| monthend |
monthend |
| yearstart |
yearstart |
| yearend |
yearend |
| weekstart |
weekstart |
| weekend |
weekend |
| yearstart-1y |
yearstart-1y |
| yearend-1y |
yearend-1y |
| monthstart-1d |
monthstart-1d |
| monthend+1d |
monthend+1d |
|
The date for which to retrieve the report in YYYYMMDD format. Supported functions now|today|yesterday|weekstart|weekend|monthstart|monthend|yearstart|yearend and supported intervals for add/subtract are ms|s|sec|min|h|hour|y|year|d|day|m|month|y|year. Example monthstart-3d (subtract 3days from month start)
|
| endDate |
End Date (yyyy-MM-dd) |
YES |
| Option |
Value |
| today |
today |
| yesterday |
yesterday |
| monthstart |
monthstart |
| monthend |
monthend |
| yearstart |
yearstart |
| yearend |
yearend |
| weekstart |
weekstart |
| weekend |
weekend |
| yearstart-1y |
yearstart-1y |
| yearend-1y |
yearend-1y |
| monthstart-1d |
monthstart-1d |
| monthend+1d |
monthend+1d |
|
The date for which to retrieve the report in YYYYMMDD format. Supported functions now|today|yesterday|weekstart|weekend|monthstart|monthend|yearstart|yearend and supported intervals for add/subtract are ms|s|sec|min|h|hour|y|year|d|day|m|month|y|year. Example monthstart-3d (subtract 3days from month start)
|
| currency |
currency |
NO |
|
|
| dimensions |
dimensions |
NO |
| Option |
Value |
| adType |
adType |
| ageGroup |
ageGroup |
| asset |
asset |
| audienceType |
audienceType |
| channel |
channel |
| claimedStatus |
claimedStatus |
| contentOwner |
contentOwner |
| country |
country |
| day |
day |
| deviceType |
deviceType |
| elapsedVideoTimeRatio |
elapsedVideoTimeRatio |
| gender |
gender |
| insightPlaybackLocationDetail |
insightPlaybackLocationDetail |
| insightPlaybackLocationType |
insightPlaybackLocationType |
| insightTrafficSourceDetail |
insightTrafficSourceDetail |
| insightTrafficSourceType |
insightTrafficSourceType |
| liveOrOnDemand |
liveOrOnDemand |
| operatingSystem |
operatingSystem |
| playlist |
playlist |
| province |
province |
| sharingService |
sharingService |
| subscribedStatus |
subscribedStatus |
| subtitleLanguage |
subtitleLanguage |
| uploaderType |
uploaderType |
| video |
video |
|
|
| filters |
filters |
NO |
| Option |
Value |
| Example1 |
country==IT |
| Example2 |
video==dMH0bHeiRNg |
| Example3 |
gender==FEMALE |
| Example4 |
dimension==some_value |
|
A list of filters that should be applied when retrieving YouTube Analytics data. The documentation for channel reports and content owner reports identifies the dimensions that can be used to filter each report, and the Dimensions document defines those dimensions.
|
| includeHistoricalChannelData |
includeHistoricalChannelData |
NO |
| Option |
Value |
| true |
true |
| false |
false |
|
|
| maxResults |
maxResults |
NO |
|
|
| sort |
sort |
NO |
| Option |
Value |
| adType |
adType |
| ageGroup |
ageGroup |
| asset |
asset |
| audienceType |
audienceType |
| channel |
channel |
| claimedStatus |
claimedStatus |
| contentOwner |
contentOwner |
| country |
country |
| day |
day |
| deviceType |
deviceType |
| elapsedVideoTimeRatio |
elapsedVideoTimeRatio |
| gender |
gender |
| insightPlaybackLocationDetail |
insightPlaybackLocationDetail |
| insightPlaybackLocationType |
insightPlaybackLocationType |
| insightTrafficSourceDetail |
insightTrafficSourceDetail |
| insightTrafficSourceType |
insightTrafficSourceType |
| liveOrOnDemand |
liveOrOnDemand |
| operatingSystem |
operatingSystem |
| playlist |
playlist |
| province |
province |
| sharingService |
sharingService |
| subscribedStatus |
subscribedStatus |
| subtitleLanguage |
subtitleLanguage |
| uploaderType |
uploaderType |
| video |
video |
|
A comma-separated list of dimensions or metrics that determine the sort order for YouTube Analytics data. By default the sort order is ascending. The - prefix causes descending sort order.
|
Output Columns
| Label |
DataType |
Length |
Raw |
Description |
| There are no Static columns defined for this endpoint. This endpoint detects columns dynamically at runtime. |
Input Columns
| Label |
DataType |
Length |
Raw |
Description |
| There are no Static columns defined for this endpoint. This endpoint detects columns dynamically at runtime. |
