Method: projects.locations.catalogs.exportAnalyticsMetrics

Exports analytics metrics.

Operation.response is of type ExportAnalyticsMetricsResponse. Operation.metadata is of type ExportMetadata.

HTTP request

POST https://retail.googleapis.com/v2beta/{catalog=projects/*/locations/*/catalogs/*}:exportAnalyticsMetrics

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
catalog

string

Required. Full resource name of the parent catalog. Expected format: projects/*/locations/*/catalogs/*

Request body

The request body contains data with the following structure:

JSON representation 
{
  "outputConfig": {
    object (OutputConfig)
  },
  "filter": string
}
Fields
outputConfig

object (OutputConfig)

Required. The output location of the data.
filter

string

A filtering expression to specify restrictions on returned metrics. The expression is a sequence of terms. Each term applies a restriction to the returned metrics. Use this expression to restrict results to a specific time range.

Currently we expect only one types of fields:

  • timestamp: This can be specified twice, once with a less than operator and once with a greater than operator. The timestamp restriction should result in one, contiguous, valid, timestamp range.

Some examples of valid filters expressions:

  • Example 1: timestamp > "2012-04-23T18:25:43.511Z" timestamp < "2012-04-23T18:30:43.511Z"
  • Example 2: timestamp > "2012-04-23T18:25:43.511Z"

Response body

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

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the catalog resource:

  • retail.catalogs.exportAnalyticsMetrics

For more information, see the IAM documentation.