Class: Google::Cloud::ContactCenterInsights::V1::QueryMetricsRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/contactcenterinsights/v1/contact_center_insights.rb

Overview

The request for querying metrics.

Defined Under Namespace

Modules: TimeGranularity

Instance Attribute Summary collapse

Instance Attribute Details

#dimensions ⇒ ::Array<::Google::Cloud::ContactCenterInsights::V1::Dimension>

Returns 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>) —

    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.



1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
 
# File 'proto_docs/google/cloud/contactcenterinsights/v1/contact_center_insights.rb', line 1516

class QueryMetricsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # 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.
  module TimeGranularity
    # The time granularity is unspecified and will default to NONE.
    TIME_GRANULARITY_UNSPECIFIED = 0

    # No time granularity. The response won't contain a time series.
    # This is the default value if no time granularity is specified.
    NONE = 1

    # Data points in the time series will aggregate at a daily granularity.
    # 1 day means [midnight to midnight).
    DAILY = 2

    # Data points in the time series will aggregate at a daily granularity.
    # 1 HOUR means [01:00 to 02:00).
    HOURLY = 3

    # Data points in the time series will aggregate at a daily granularity.
    # PER_MINUTE means [01:00 to 01:01).
    PER_MINUTE = 4

    # Data points in the time series will aggregate at a 1 minute  granularity.
    # PER_5_MINUTES means [01:00 to 01:05).
    PER_5_MINUTES = 5

    # Data points in the time series will aggregate at a monthly granularity.
    # 1 MONTH means [01st of the month to 1st of the next month).
    MONTHLY = 6
  end
end

#filter ⇒ ::String

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



1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
 
# File 'proto_docs/google/cloud/contactcenterinsights/v1/contact_center_insights.rb', line 1516

class QueryMetricsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # 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.
  module TimeGranularity
    # The time granularity is unspecified and will default to NONE.
    TIME_GRANULARITY_UNSPECIFIED = 0

    # No time granularity. The response won't contain a time series.
    # This is the default value if no time granularity is specified.
    NONE = 1

    # Data points in the time series will aggregate at a daily granularity.
    # 1 day means [midnight to midnight).
    DAILY = 2

    # Data points in the time series will aggregate at a daily granularity.
    # 1 HOUR means [01:00 to 02:00).
    HOURLY = 3

    # Data points in the time series will aggregate at a daily granularity.
    # PER_MINUTE means [01:00 to 01:01).
    PER_MINUTE = 4

    # Data points in the time series will aggregate at a 1 minute  granularity.
    # PER_5_MINUTES means [01:00 to 01:05).
    PER_5_MINUTES = 5

    # Data points in the time series will aggregate at a monthly granularity.
    # 1 MONTH means [01st of the month to 1st of the next month).
    MONTHLY = 6
  end
end

#location ⇒ ::String

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

Returns:

  • (::String) —

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



1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
 
# File 'proto_docs/google/cloud/contactcenterinsights/v1/contact_center_insights.rb', line 1516

class QueryMetricsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # 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.
  module TimeGranularity
    # The time granularity is unspecified and will default to NONE.
    TIME_GRANULARITY_UNSPECIFIED = 0

    # No time granularity. The response won't contain a time series.
    # This is the default value if no time granularity is specified.
    NONE = 1

    # Data points in the time series will aggregate at a daily granularity.
    # 1 day means [midnight to midnight).
    DAILY = 2

    # Data points in the time series will aggregate at a daily granularity.
    # 1 HOUR means [01:00 to 02:00).
    HOURLY = 3

    # Data points in the time series will aggregate at a daily granularity.
    # PER_MINUTE means [01:00 to 01:01).
    PER_MINUTE = 4

    # Data points in the time series will aggregate at a 1 minute  granularity.
    # PER_5_MINUTES means [01:00 to 01:05).
    PER_5_MINUTES = 5

    # Data points in the time series will aggregate at a monthly granularity.
    # 1 MONTH means [01st of the month to 1st of the next month).
    MONTHLY = 6
  end
end

#measure_mask ⇒ ::Google::Protobuf::FieldMask

Returns 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) —

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



1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
 
# File 'proto_docs/google/cloud/contactcenterinsights/v1/contact_center_insights.rb', line 1516

class QueryMetricsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # 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.
  module TimeGranularity
    # The time granularity is unspecified and will default to NONE.
    TIME_GRANULARITY_UNSPECIFIED = 0

    # No time granularity. The response won't contain a time series.
    # This is the default value if no time granularity is specified.
    NONE = 1

    # Data points in the time series will aggregate at a daily granularity.
    # 1 day means [midnight to midnight).
    DAILY = 2

    # Data points in the time series will aggregate at a daily granularity.
    # 1 HOUR means [01:00 to 02:00).
    HOURLY = 3

    # Data points in the time series will aggregate at a daily granularity.
    # PER_MINUTE means [01:00 to 01:01).
    PER_MINUTE = 4

    # Data points in the time series will aggregate at a 1 minute  granularity.
    # PER_5_MINUTES means [01:00 to 01:05).
    PER_5_MINUTES = 5

    # Data points in the time series will aggregate at a monthly granularity.
    # 1 MONTH means [01st of the month to 1st of the next month).
    MONTHLY = 6
  end
end

#time_granularity ⇒ ::Google::Cloud::ContactCenterInsights::V1::QueryMetricsRequest::TimeGranularity

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

Returns:



1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
 
# File 'proto_docs/google/cloud/contactcenterinsights/v1/contact_center_insights.rb', line 1516

class QueryMetricsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # 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.
  module TimeGranularity
    # The time granularity is unspecified and will default to NONE.
    TIME_GRANULARITY_UNSPECIFIED = 0

    # No time granularity. The response won't contain a time series.
    # This is the default value if no time granularity is specified.
    NONE = 1

    # Data points in the time series will aggregate at a daily granularity.
    # 1 day means [midnight to midnight).
    DAILY = 2

    # Data points in the time series will aggregate at a daily granularity.
    # 1 HOUR means [01:00 to 02:00).
    HOURLY = 3

    # Data points in the time series will aggregate at a daily granularity.
    # PER_MINUTE means [01:00 to 01:01).
    PER_MINUTE = 4

    # Data points in the time series will aggregate at a 1 minute  granularity.
    # PER_5_MINUTES means [01:00 to 01:05).
    PER_5_MINUTES = 5

    # Data points in the time series will aggregate at a monthly granularity.
    # 1 MONTH means [01st of the month to 1st of the next month).
    MONTHLY = 6
  end
end