Contact Center AI Insights v1 API - Class QueryMetricsRequest (2.18.0) 

public sealed class QueryMetricsRequest : IMessage<QueryMetricsRequest>, IEquatable<QueryMetricsRequest>, IDeepCloneable<QueryMetricsRequest>, IBufferMessage, IMessage

Reference documentation and code samples for the Contact Center AI Insights v1 API class QueryMetricsRequest.

The request for querying metrics.

Inheritance

object > QueryMetricsRequest

Namespace

Google.Cloud.ContactCenterInsights.V1

Assembly

Google.Cloud.ContactCenterInsights.V1.dll

Constructors

QueryMetricsRequest()

public QueryMetricsRequest()

QueryMetricsRequest(QueryMetricsRequest)

public QueryMetricsRequest(QueryMetricsRequest other)
Parameter
Name Description
other QueryMetricsRequest

Properties

Dimensions

public RepeatedField<Dimension> Dimensions { get; }

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.

Property Value
Type Description
RepeatedFieldDimension

Filter

public string Filter { get; set; }

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)).

Property Value
Type Description
string

Location

public string Location { get; set; }

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

Property Value
Type Description
string

LocationAsLocationName

public LocationName LocationAsLocationName { get; set; }

LocationName-typed view over the Location resource name property.

Property Value
Type Description
LocationName

MeasureMask

public FieldMask MeasureMask { get; set; }

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 "conversation_measure.count".

Property Value
Type Description
FieldMask

TimeGranularity

public QueryMetricsRequest.Types.TimeGranularity TimeGranularity { get; set; }

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

Property Value
Type Description
QueryMetricsRequestTypesTimeGranularity