Method: properties.reportTasks.get

  • This method is used to retrieve metadata about a specific report task, including its processing state and report definition.

  • The HTTP request uses a GET method with a URL format that includes the property and report task names.

  • The only required parameter is the name in the path, which specifies the report task resource.

  • The request body must be empty.

  • A successful response returns an instance of ReportTask.

  • The method requires specific OAuth scopes for authorization, either https://www.googleapis.com/auth/analytics.readonly or https://www.googleapis.com/auth/analytics.

Gets report metadata about a specific report task. After creating a report task, use this method to check its processing state or inspect its report definition.

HTTP request

GET https://analyticsdata.googleapis.com/v1alpha/{name=properties/*/reportTasks/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The report task resource name. Format: properties/{property}/reportTasks/{reportTask}

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of ReportTask.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics