# Contact Center AI Insights V1 API - Class Google::Cloud::ContactCenterInsights::V1::QueryMetricsRequest (v1.10.0)

1.10.0 (latest) 1.9.0 1.8.1 1.7.0 1.6.0 1.5.1 1.4.0 1.3.0 1.2.0 1.1.0 1.0.1 0.22.0 0.21.1 0.20.1 0.19.1 0.18.0 0.17.0 0.16.0 0.15.0 0.14.0 0.13.0 0.12.0 0.11.0 0.10.0 0.9.0 0.8.2 0.7.2 0.6.0 Reference documentation and code samples for the Contact Center AI Insights V1 API class Google::Cloud::ContactCenterInsights::V1::QueryMetricsRequest.

The request for querying metrics.

## Inherits

- Object

## Extended By

- Google::Protobuf::MessageExts::ClassMethods

## Includes

- Google::Protobuf::MessageExts

## Methods

### #dimensions

    def dimensions() -> ::Array<::Google::Cloud::ContactCenterInsights::V1::Dimension>

**Returns**

- (::Array\<[::Google::Cloud::ContactCenterInsights::V1::Dimension](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-contact_center_insights-v1/latest/Google-Cloud-ContactCenterInsights-V1-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.

### #dimensions=

    def dimensions=(value) -> ::Array<::Google::Cloud::ContactCenterInsights::V1::Dimension>

**Parameter**

- **value** (::Array\<[::Google::Cloud::ContactCenterInsights::V1::Dimension](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-contact_center_insights-v1/latest/Google-Cloud-ContactCenterInsights-V1-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.
**Returns**

- (::Array\<[::Google::Cloud::ContactCenterInsights::V1::Dimension](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-contact_center_insights-v1/latest/Google-Cloud-ContactCenterInsights-V1-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.

### #filter

    def filter() -> ::String

**Returns**

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

### #filter=

    def filter=(value) -> ::String

**Parameter**

- **value** (::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)).
**Returns**

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

### #location

    def location() -> ::String

**Returns**

- (::String) --- Required. The location of the data. "projects/{project}/locations/{location}"

### #location=

    def location=(value) -> ::String

**Parameter**

- **value** (::String) --- Required. The location of the data. "projects/{project}/locations/{location}"
**Returns**

- (::String) --- Required. The location of the data. "projects/{project}/locations/{location}"

### #measure_mask

    def measure_mask() -> ::Google::Protobuf::FieldMask

**Returns**

- ([::Google::Protobuf::FieldMask](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-contact_center_insights-v1/latest/Google-Protobuf-FieldMask)) --- 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".

### #measure_mask=

    def measure_mask=(value) -> ::Google::Protobuf::FieldMask

**Parameter**

- **value** ([::Google::Protobuf::FieldMask](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-contact_center_insights-v1/latest/Google-Protobuf-FieldMask)) --- 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".
**Returns**

- ([::Google::Protobuf::FieldMask](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-contact_center_insights-v1/latest/Google-Protobuf-FieldMask)) --- 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".

### #time_granularity

    def time_granularity() -> ::Google::Cloud::ContactCenterInsights::V1::QueryMetricsRequest::TimeGranularity

**Returns**

- ([::Google::Cloud::ContactCenterInsights::V1::QueryMetricsRequest::TimeGranularity](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-contact_center_insights-v1/latest/Google-Cloud-ContactCenterInsights-V1-QueryMetricsRequest-TimeGranularity)) --- The time granularity of each data point in the time series. Defaults to NONE if this field is unspecified.

### #time_granularity=

    def time_granularity=(value) -> ::Google::Cloud::ContactCenterInsights::V1::QueryMetricsRequest::TimeGranularity

**Parameter**

- **value** ([::Google::Cloud::ContactCenterInsights::V1::QueryMetricsRequest::TimeGranularity](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-contact_center_insights-v1/latest/Google-Cloud-ContactCenterInsights-V1-QueryMetricsRequest-TimeGranularity)) --- The time granularity of each data point in the time series. Defaults to NONE if this field is unspecified.
**Returns**

- ([::Google::Cloud::ContactCenterInsights::V1::QueryMetricsRequest::TimeGranularity](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-contact_center_insights-v1/latest/Google-Cloud-ContactCenterInsights-V1-QueryMetricsRequest-TimeGranularity)) --- The time granularity of each data point in the time series. Defaults to NONE if this field is unspecified.