Method: projects.locations.queryMetrics

Query metrics.

HTTP request

POST https://{endpoint}/v1/{location=projects/*/locations/*}:queryMetrics

Where {endpoint} is one of the supported service endpoints.

The URLs use gRPC Transcoding syntax.

Path parameters

Parameters
location

string

Required. The location of the data. "projects/{project}/locations/{location}"

Request body

The request body contains data with the following structure:

JSON representation 
{
  "filter": string,
  "timeGranularity": enum (TimeGranularity),
  "dimensions": [
    {
      object (Dimension)
    }
  ],
  "measureMask": string
}
Fields
filter

string

Required. Filter to select a subset of conversations to compute the metrics. Must specify a window of the conversation create time to compute the metrics. The returned metrics will be from the range [DATE(starting create time), DATE(ending create time)).
timeGranularity

enum (TimeGranularity)

The time granularity of each data point in the time series. Defaults to NONE if this field is unspecified.
dimensions[]

object (Dimension)

The dimensions that determine the grouping key for the query. Defaults to no dimension if this field is unspecified. If a dimension is specified, its key must also be specified. Each dimension's key must be unique.

If a time granularity is also specified, metric values in the dimension will be bucketed by this granularity.

Up to one dimension is supported for now.
measureMask

string (FieldMask format)

Measures to return. Defaults to all measures if this field is unspecified. A valid mask should traverse from the measure field from the response. For example, a path from a measure mask to get the conversation count is "conversationMeasure.count".

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

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 location resource:

  • contactcenterinsights.conversations.list

For more information, see the IAM documentation.

TimeGranularity

A time granularity divides the time line into discrete time periods. This is useful for defining buckets over which filtering and aggregation should be performed.

Enums
TIME_GRANULARITY_UNSPECIFIED The time granularity is unspecified and will default to NONE.
NONE No time granularity. The response won't contain a time series. This is the default value if no time granularity is specified.
DAILY Data points in the time series will aggregate at a daily granularity. 1 day means [midnight to midnight).
HOURLY Data points in the time series will aggregate at a daily granularity. 1 HOUR means [01:00 to 02:00).
PER_MINUTE Data points in the time series will aggregate at a daily granularity. PER_MINUTE means [01:00 to 01:01).
PER_5_MINUTES Data points in the time series will aggregate at a 1 minute granularity. PER_5_MINUTES means [01:00 to 01:05).