Method: properties.audienceExports.get

  • This API endpoint retrieves configuration metadata for a specific audience export, allowing users to understand its details after creation.

  • The request requires the name path parameter specifying the audience export resource in the format properties/{property}/audienceExports/{audienceExport}.

  • Successful responses provide an AudienceExport object containing the export's metadata.

  • Authorization requires either the https://www.googleapis.com/auth/analytics.readonly or https://www.googleapis.com/auth/analytics OAuth scope.

  • Refer to the "Creating an Audience Export" guide for introductory information and examples related to Audience Exports.

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 Audience Exports with examples.

Audience Export APIs have some methods at alpha and other methods at beta stability. The intention is to advance methods to beta stability after some feedback and adoption. To give your feedback on this API, complete the Google Analytics Audience Export API Feedback form.

HTTP request

GET https://analyticsdata.googleapis.com/v1beta/{name=properties/*/audienceExports/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The audience export resource name. Format: properties/{property}/audienceExports/{audienceExport}

Request body

The request body must be empty.

Response body

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

Authorization scopes

Requires one of the following OAuth scopes:

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