api reference · v1beta

Every Analytics Data method, from the index.

All 11 methods of the Analytics Data API, rendered at build time from the committed Discovery index the grr binary embeds — the same data grr api describe reads at runtime. Flags are kebab-cased parameter names: userId is --user-id.

11 methods · v1beta · revision 20260923

analyticsdata.properties.audienceExports

4 methods

analyticsdata.properties.audienceExports.create

POST

grr analyticsdata properties audienceExports create v1beta/{+parent}/audienceExports

Creates an audience export for later retrieval. This method quickly returns the audience export's resource name and initiates a long running asynchronous request to form an audience export. To export the users in an audience export, first create the audience export through this method and then send

Parameter Type Required Repeated Location Description Enum values
parent string yes — path Required. The parent resource where this audience export will be created. Format: `properties/{property}` —

https://www.googleapis.com/auth/analytics.readonly least privilege

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

grr analyticsdata properties audienceExports create
grr analyticsdata properties audienceExports create --parent <parent> --body-file ./body.json

analyticsdata.properties.audienceExports.get

GET

grr analyticsdata properties audienceExports get v1beta/{+name}

Gets configuration metadata about a specific audience export. This method can be used to understand an audience export after it has been created. See Creating an Audience Export for an introduction to Audienc

Parameter Type Required Repeated Location Description Enum values
name string yes — path Required. The audience export resource name. Format: `properties/{property}/audienceExports/{audience_export}` —

https://www.googleapis.com/auth/analytics.readonly least privilege

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

grr analyticsdata properties audienceExports get
grr analyticsdata properties audienceExports get --name <name>

analyticsdata.properties.audienceExports.list

GET

grr analyticsdata properties audienceExports list v1beta/{+parent}/audienceExports

Lists all audience exports for a property. This method can be used for you to find and reuse existing audience exports rather than creating unnecessary new audience exports. The same audience can have multiple audience exports that represent the export of users that were in an audience on different

Parameter Type Required Repeated Location Description Enum values
pageSize integer — — query Optional. The maximum number of audience exports to return. The service may return fewer than this value. If unspecified, at most 200 audience exports will be r —
pageToken string — — query Optional. A page token, received from a previous `ListAudienceExports` call. Provide this to retrieve the subsequent page. When paginating, all other parameters —
parent string yes — path Required. All audience exports for this property will be listed in the response. Format: `properties/{property}` —

https://www.googleapis.com/auth/analytics.readonly least privilege

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

grr analyticsdata properties audienceExports list
grr analyticsdata properties audienceExports list --parent <parent>

analyticsdata.properties.audienceExports.query

POST

grr analyticsdata properties audienceExports query v1beta/{+name}:query

Retrieves an audience export of users. After creating an audience, the users are not immediately available for exporting. First, a request to `CreateAudienceExport` is necessary to create an audience export of users, and then second, this method is used to retrieve the users in the audience export.

Parameter Type Required Repeated Location Description Enum values
name string yes — path Required. The name of the audience export to retrieve users from. Format: `properties/{property}/audienceExports/{audience_export}` —

https://www.googleapis.com/auth/analytics.readonly least privilege

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

grr analyticsdata properties audienceExports query
grr analyticsdata properties audienceExports query --name <name> --body-file ./body.json

analyticsdata.properties

7 methods

analyticsdata.properties.batchRunPivotReports

POST

grr analyticsdata properties batchRunPivotReports v1beta/{+property}:batchRunPivotReports

Returns multiple pivot reports in a batch. All reports must be for the same Google Analytics property.

Parameter Type Required Repeated Location Description Enum values
property string yes — path A Google Analytics property identifier whose events are tracked. Specified in the URL path and not the body. To learn more, see [where to find your Property ID] —

https://www.googleapis.com/auth/analytics.readonly least privilege

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

grr analyticsdata properties batchRunPivotReports
grr analyticsdata properties batchRunPivotReports --property <property> --body-file ./body.json

analyticsdata.properties.batchRunReports

POST

grr analyticsdata properties batchRunReports v1beta/{+property}:batchRunReports

Returns multiple reports in a batch. All reports must be for the same Google Analytics property.

Parameter Type Required Repeated Location Description Enum values
property string yes — path A Google Analytics property identifier whose events are tracked. Specified in the URL path and not the body. To learn more, see [where to find your Property ID] —

https://www.googleapis.com/auth/analytics.readonly least privilege

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

grr analyticsdata properties batchRunReports
grr analyticsdata properties batchRunReports --property <property> --body-file ./body.json

analyticsdata.properties.checkCompatibility

POST

grr analyticsdata properties checkCompatibility v1beta/{+property}:checkCompatibility

This compatibility method lists dimensions and metrics that can be added to a report request and maintain compatibility. This method fails if the request's dimensions and metrics are incompatible. In Google Analytics, reports fail if they request incompatible dimensions and/or metrics; in that case,

Parameter Type Required Repeated Location Description Enum values
property string yes — path A Google Analytics property identifier whose events are tracked. To learn more, see [where to find your Property ID](https://developers.google.com/analytics/dev —

https://www.googleapis.com/auth/analytics.readonly least privilege

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

grr analyticsdata properties checkCompatibility
grr analyticsdata properties checkCompatibility --property <property> --body-file ./body.json

analyticsdata.properties.getMetadata

GET

grr analyticsdata properties getMetadata v1beta/{+name}

Returns metadata for dimensions and metrics available in reporting methods. Used to explore the dimensions and metrics. In this method, a Google Analytics property identifier is specified in the request, and the metadata response includes Custom dimensions and metrics as well as Universal metadata.

Parameter Type Required Repeated Location Description Enum values
name string yes — path Required. The resource name of the metadata to retrieve. This name field is specified in the URL path and not URL parameters. Property is a numeric Google Analy —

https://www.googleapis.com/auth/analytics.readonly least privilege

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

grr analyticsdata properties getMetadata
grr analyticsdata properties getMetadata --name <name>

analyticsdata.properties.runPivotReport

POST

grr analyticsdata properties runPivotReport v1beta/{+property}:runPivotReport

Returns a customized pivot report of your Google Analytics event data. Pivot reports are more advanced and expressive formats than regular reports. In a pivot report, dimensions are only visible if they are included in a pivot. Multiple pivots can be specified to further dissect your data.

Parameter Type Required Repeated Location Description Enum values
property string yes — path A Google Analytics property identifier whose events are tracked. Specified in the URL path and not the body. To learn more, see [where to find your Property ID] —

https://www.googleapis.com/auth/analytics.readonly least privilege

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

grr analyticsdata properties runPivotReport
grr analyticsdata properties runPivotReport --property <property> --body-file ./body.json

analyticsdata.properties.runRealtimeReport

POST

grr analyticsdata properties runRealtimeReport v1beta/{+property}:runRealtimeReport

Returns a customized report of realtime event data for your property. Events appear in realtime reports seconds after they have been sent to the Google Analytics. Realtime reports show events and usage data for the periods of time ranging from the present moment to 30 minutes ago (up to 60 minutes f

Parameter Type Required Repeated Location Description Enum values
property string yes — path A Google Analytics property identifier whose events are tracked. Specified in the URL path and not the body. To learn more, see [where to find your Property ID] —

https://www.googleapis.com/auth/analytics.readonly least privilege

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

grr analyticsdata properties runRealtimeReport
grr analyticsdata properties runRealtimeReport --property <property> --body-file ./body.json

analyticsdata.properties.runReport

POST

grr analyticsdata properties runReport v1beta/{+property}:runReport

Returns a customized report of your Google Analytics event data. Reports contain statistics derived from data collected by the Google Analytics tracking code. The data returned from the API is as a table with columns for the requested dimensions and metrics. Metrics are individual measurements of us

Parameter Type Required Repeated Location Description Enum values
property string yes — path A Google Analytics property identifier whose events are tracked. Specified in the URL path and not the body. To learn more, see [where to find your Property ID] —

https://www.googleapis.com/auth/analytics.readonly least privilege

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

grr analyticsdata properties runReport
grr analyticsdata properties runReport --property <property> --body-file ./body.json