YouTube Analytics API v1

Version: 5.3

YouTube Analytics API v1

This documentation has been automatically generated using information supplied by the Google API Discovery service.

Retrieve your YouTube Analytics reports. Google documentation.

1 API Parameters

2 Resources

2.1 reports

(require gapi/macro)

(require-gapi-doc "youtubeAnalytics.v1.js")

1 API Parameters

The following optional keyword arguments may be passed to all functions for this web service:

procedure
(_ [ #:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp]) → jsexpr?
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

This is not actually a function. This is just using Scribble’s defproc form to list the optional keyword arguments that may be passed to all functions for this service.

alt: Data format for the response.

fields: Selector specifying which fields to include in a partial response.

key: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

oauth_token: OAuth 2.0 token for the current user.

prettyPrint: Returns response with indentations and line breaks.

quotaUser: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

userIp: IP address of the site where the request originates. Use this if you want to enforce per-user limits.

2 Resources

2.1 reports

procedure
(youtubeAnalytics-reports-query #:end-date end-date
#:ids ids
#:metrics metrics
#:start-date start-date
[ #:sort sort
#:dimensions dimensions
#:filters filters
#:max-results max-results
#:start-index start-index
#:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp])
→ jsexpr?
  end-date : string?
  ids : string?
  metrics : string?
  start-date : string?
  sort : string? = 'N/A
  dimensions : string? = 'N/A
  filters : string? = 'N/A
  max-results : string? = 'N/A
  start-index : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Retrieve your YouTube Analytics reports.

end-date: End date for fetching YouTube Analytics data. All requests should specify an end date formatted as YYYY-MM-DD.

ids: Unique channel or content owner ID for retrieving YouTube Analytics data. Either channel==C or contentOwner==O where ’C’ is the encrypted channel ID and ’O’ is the content owner name.

metrics: A comma-separated list of YouTube Analytics metrics. E.g., ’views’ or ’likes,dislikes’

start-date: Start date for fetching YouTube Analytics data. All requests should specify a start date formatted as YYYY-MM-DD.

sort: A comma-separated list of dimensions or metrics that determine the sort order for YouTube Analytics data. By default the sort order is ascending, ’-’ prefix causes descending sort order.

dimensions: A comma-separated list of YouTube Analytics dimensions. E.g., ’video’, or ’ageGroup,gender’.

filters: A list of dimension filters to be applied to YouTube Analytics data. Multiple filters can be joined together with the ’;’ character. The returned result table will satisfy both filters. E.g., video==dMH0bHeiRNg;country==IT will restrict the returned stats to the given video and the country Italy.

max-results: The maximum number of rows to include in the response.

start-index: An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter (one-based, inclusive).