Method jobs.get

  • This endpoint retrieves details about a specific reporting job identified by its jobId.

  • Authorization is required for all requests, using either https://www.googleapis.com/auth/yt-analytics.readonly or https://www.googleapis.com/auth/yt-analytics-monetary.readonly scopes.

  • The jobId is a required path parameter, identifying the specific job to retrieve.

  • The optional onBehalfOfContentOwner query parameter specifies the content owner for the request, otherwise defaults to the user's channel.

  • A successful request returns a Job resource in the response body, and the request body itself must be empty.

Retrieves information about a specific reporting job that has been scheduled for a channel or content owner.

Request

HTTP request

GET https://youtubereporting.googleapis.com/v1/jobs/{jobId}

Authorization

All YouTube Reporting API requests must be authorized. The Authorization guide explains how to use the OAuth 2.0 protocol to retrieve authorization tokens.

YouTube Reporting API requests use the following authorization scopes:

Scopes
https://www.googleapis.com/auth/yt-analytics.readonly View YouTube Analytics reports for your YouTube content. This scope provides access to user activity metrics, like view counts and rating counts.
https://www.googleapis.com/auth/yt-analytics-monetary.readonly View YouTube Analytics monetary reports for your YouTube content. This scope provides access to user activity metrics and to estimated revenue and ad performance metrics.

Parameters

Path parameters

Parameters
jobId string
The ID that YouTube uses to uniquely identify the job being retrieved.

Query parameters

Parameters
onBehalfOfContentOwner string
The ID of the content owner for whom the API request is being made. If the request does not specify a value for this parameter, the API server assumes that the request is being made for the user's own channel.

Request body

The request body must be empty.

Response

If successful, the response body contains a Job resource.

Try it!