Class: Google::Cloud::ContactCenterInsights::V1::QueryMetricsResponse

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 response for querying metrics.

Defined Under Namespace

Classes: Slice

Instance Attribute Summary collapse

Instance Attribute Details

#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}"



1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
 
# File 'proto_docs/google/cloud/contactcenterinsights/v1/contact_center_insights.rb', line 1564

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

  # A slice contains a total and (if the request specified a time granularity)
  # a time series of metric values. Each slice contains a unique combination of
  # the cardinality of dimensions from the request.
  #
  # For example, if the request specifies a single ISSUE dimension and it has a
  # cardinality of 2 (i.e. the data used to compute the metrics has 2 issues in
  # total), the response will have 2 slices:
  #
  # * Slice 1 -> dimensions=[Issue 1]
  # * Slice 2 -> dimensions=[Issue 2]
  # @!attribute [rw] dimensions
  #   @return [::Array<::Google::Cloud::ContactCenterInsights::V1::Dimension>]
  #     A unique combination of dimensions that this slice represents.
  # @!attribute [rw] total
  #   @return [::Google::Cloud::ContactCenterInsights::V1::QueryMetricsResponse::Slice::DataPoint]
  #     The total metric value. The interval of this data point is
  #     [starting create time, ending create time) from the request.
  # @!attribute [rw] time_series
  #   @return [::Google::Cloud::ContactCenterInsights::V1::QueryMetricsResponse::Slice::TimeSeries]
  #     A time series of metric values. This is only populated if the request
  #     specifies a time granularity other than NONE.
  class Slice
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # A data point contains the metric values mapped to an interval.
    # @!attribute [rw] conversation_measure
    #   @return [::Google::Cloud::ContactCenterInsights::V1::QueryMetricsResponse::Slice::DataPoint::ConversationMeasure]
    #     The measure related to conversations.
    # @!attribute [rw] interval
    #   @return [::Google::Type::Interval]
    #     The interval that this data point represents.
    #
    #     * If this is the total data point, the interval is
    #     [starting create time, ending create time) from the request.
    #     * If this a data point from the time series, the interval is
    #     [time, time + time granularity from the request).
    class DataPoint
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # The measure related to conversations.
      # @!attribute [rw] conversation_count
      #   @return [::Integer]
      #     The conversation count.
      # @!attribute [rw] average_silence_percentage
      #   @return [::Float]
      #     The average silence percentage.
      # @!attribute [rw] average_duration
      #   @return [::Google::Protobuf::Duration]
      #     The average duration.
      # @!attribute [rw] average_turn_count
      #   @return [::Float]
      #     The average turn count.
      # @!attribute [rw] average_agent_sentiment_score
      #   @return [::Float]
      #     The average agent's sentiment score.
      # @!attribute [rw] average_client_sentiment_score
      #   @return [::Float]
      #     The average client's sentiment score.
      # @!attribute [rw] average_customer_satisfaction_rating
      #   @return [::Float]
      #     The average customer satisfaction rating.
      # @!attribute [rw] average_qa_normalized_score
      #   @return [::Float]
      #     Average QA normalized score.
      #     Will exclude 0's in average calculation.
      # @!attribute [rw] qa_tag_scores
      #   @return [::Array<::Google::Cloud::ContactCenterInsights::V1::QueryMetricsResponse::Slice::DataPoint::ConversationMeasure::QaTagScore>]
      #     Average QA normalized score for all the tags.
      # @!attribute [rw] average_qa_question_normalized_score
      #   @return [::Float]
      #     Average QA normalized score averaged for questions averaged across
      #     all revisions of the parent scorecard.
      #     Will be only populated if the request specifies a dimension of
      #     QA_QUESTION_ID.
      class ConversationMeasure
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods

        # Average QA normalized score for the tag.
        # @!attribute [rw] tag
        #   @return [::String]
        #     Tag name.
        # @!attribute [rw] average_tag_normalized_score
        #   @return [::Float]
        #     Average tag normalized score per tag.
        class QaTagScore
          include ::Google::Protobuf::MessageExts
          extend ::Google::Protobuf::MessageExts::ClassMethods
        end
      end
    end

    # A time series of metric values.
    # @!attribute [rw] data_points
    #   @return [::Array<::Google::Cloud::ContactCenterInsights::V1::QueryMetricsResponse::Slice::DataPoint>]
    #     The data points that make up the time series .
    class TimeSeries
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end
end

#macro_average_slice ⇒ ::Google::Cloud::ContactCenterInsights::V1::QueryMetricsResponse::Slice

Returns The macro average slice contains aggregated averages across the selected dimension. i.e. if group_by agent is specified this field will contain the average across all agents. This field is only populated if the request specifies a Dimension.

Returns:



1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
 
# File 'proto_docs/google/cloud/contactcenterinsights/v1/contact_center_insights.rb', line 1564

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

  # A slice contains a total and (if the request specified a time granularity)
  # a time series of metric values. Each slice contains a unique combination of
  # the cardinality of dimensions from the request.
  #
  # For example, if the request specifies a single ISSUE dimension and it has a
  # cardinality of 2 (i.e. the data used to compute the metrics has 2 issues in
  # total), the response will have 2 slices:
  #
  # * Slice 1 -> dimensions=[Issue 1]
  # * Slice 2 -> dimensions=[Issue 2]
  # @!attribute [rw] dimensions
  #   @return [::Array<::Google::Cloud::ContactCenterInsights::V1::Dimension>]
  #     A unique combination of dimensions that this slice represents.
  # @!attribute [rw] total
  #   @return [::Google::Cloud::ContactCenterInsights::V1::QueryMetricsResponse::Slice::DataPoint]
  #     The total metric value. The interval of this data point is
  #     [starting create time, ending create time) from the request.
  # @!attribute [rw] time_series
  #   @return [::Google::Cloud::ContactCenterInsights::V1::QueryMetricsResponse::Slice::TimeSeries]
  #     A time series of metric values. This is only populated if the request
  #     specifies a time granularity other than NONE.
  class Slice
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # A data point contains the metric values mapped to an interval.
    # @!attribute [rw] conversation_measure
    #   @return [::Google::Cloud::ContactCenterInsights::V1::QueryMetricsResponse::Slice::DataPoint::ConversationMeasure]
    #     The measure related to conversations.
    # @!attribute [rw] interval
    #   @return [::Google::Type::Interval]
    #     The interval that this data point represents.
    #
    #     * If this is the total data point, the interval is
    #     [starting create time, ending create time) from the request.
    #     * If this a data point from the time series, the interval is
    #     [time, time + time granularity from the request).
    class DataPoint
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # The measure related to conversations.
      # @!attribute [rw] conversation_count
      #   @return [::Integer]
      #     The conversation count.
      # @!attribute [rw] average_silence_percentage
      #   @return [::Float]
      #     The average silence percentage.
      # @!attribute [rw] average_duration
      #   @return [::Google::Protobuf::Duration]
      #     The average duration.
      # @!attribute [rw] average_turn_count
      #   @return [::Float]
      #     The average turn count.
      # @!attribute [rw] average_agent_sentiment_score
      #   @return [::Float]
      #     The average agent's sentiment score.
      # @!attribute [rw] average_client_sentiment_score
      #   @return [::Float]
      #     The average client's sentiment score.
      # @!attribute [rw] average_customer_satisfaction_rating
      #   @return [::Float]
      #     The average customer satisfaction rating.
      # @!attribute [rw] average_qa_normalized_score
      #   @return [::Float]
      #     Average QA normalized score.
      #     Will exclude 0's in average calculation.
      # @!attribute [rw] qa_tag_scores
      #   @return [::Array<::Google::Cloud::ContactCenterInsights::V1::QueryMetricsResponse::Slice::DataPoint::ConversationMeasure::QaTagScore>]
      #     Average QA normalized score for all the tags.
      # @!attribute [rw] average_qa_question_normalized_score
      #   @return [::Float]
      #     Average QA normalized score averaged for questions averaged across
      #     all revisions of the parent scorecard.
      #     Will be only populated if the request specifies a dimension of
      #     QA_QUESTION_ID.
      class ConversationMeasure
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods

        # Average QA normalized score for the tag.
        # @!attribute [rw] tag
        #   @return [::String]
        #     Tag name.
        # @!attribute [rw] average_tag_normalized_score
        #   @return [::Float]
        #     Average tag normalized score per tag.
        class QaTagScore
          include ::Google::Protobuf::MessageExts
          extend ::Google::Protobuf::MessageExts::ClassMethods
        end
      end
    end

    # A time series of metric values.
    # @!attribute [rw] data_points
    #   @return [::Array<::Google::Cloud::ContactCenterInsights::V1::QueryMetricsResponse::Slice::DataPoint>]
    #     The data points that make up the time series .
    class TimeSeries
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end
end

#slices ⇒ ::Array<::Google::Cloud::ContactCenterInsights::V1::QueryMetricsResponse::Slice>

Returns A slice contains a total and (if the request specified a time granularity) a time series of metric values. Each slice contains a unique combination of the cardinality of dimensions from the request.

Returns:



1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
 
# File 'proto_docs/google/cloud/contactcenterinsights/v1/contact_center_insights.rb', line 1564

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

  # A slice contains a total and (if the request specified a time granularity)
  # a time series of metric values. Each slice contains a unique combination of
  # the cardinality of dimensions from the request.
  #
  # For example, if the request specifies a single ISSUE dimension and it has a
  # cardinality of 2 (i.e. the data used to compute the metrics has 2 issues in
  # total), the response will have 2 slices:
  #
  # * Slice 1 -> dimensions=[Issue 1]
  # * Slice 2 -> dimensions=[Issue 2]
  # @!attribute [rw] dimensions
  #   @return [::Array<::Google::Cloud::ContactCenterInsights::V1::Dimension>]
  #     A unique combination of dimensions that this slice represents.
  # @!attribute [rw] total
  #   @return [::Google::Cloud::ContactCenterInsights::V1::QueryMetricsResponse::Slice::DataPoint]
  #     The total metric value. The interval of this data point is
  #     [starting create time, ending create time) from the request.
  # @!attribute [rw] time_series
  #   @return [::Google::Cloud::ContactCenterInsights::V1::QueryMetricsResponse::Slice::TimeSeries]
  #     A time series of metric values. This is only populated if the request
  #     specifies a time granularity other than NONE.
  class Slice
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # A data point contains the metric values mapped to an interval.
    # @!attribute [rw] conversation_measure
    #   @return [::Google::Cloud::ContactCenterInsights::V1::QueryMetricsResponse::Slice::DataPoint::ConversationMeasure]
    #     The measure related to conversations.
    # @!attribute [rw] interval
    #   @return [::Google::Type::Interval]
    #     The interval that this data point represents.
    #
    #     * If this is the total data point, the interval is
    #     [starting create time, ending create time) from the request.
    #     * If this a data point from the time series, the interval is
    #     [time, time + time granularity from the request).
    class DataPoint
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # The measure related to conversations.
      # @!attribute [rw] conversation_count
      #   @return [::Integer]
      #     The conversation count.
      # @!attribute [rw] average_silence_percentage
      #   @return [::Float]
      #     The average silence percentage.
      # @!attribute [rw] average_duration
      #   @return [::Google::Protobuf::Duration]
      #     The average duration.
      # @!attribute [rw] average_turn_count
      #   @return [::Float]
      #     The average turn count.
      # @!attribute [rw] average_agent_sentiment_score
      #   @return [::Float]
      #     The average agent's sentiment score.
      # @!attribute [rw] average_client_sentiment_score
      #   @return [::Float]
      #     The average client's sentiment score.
      # @!attribute [rw] average_customer_satisfaction_rating
      #   @return [::Float]
      #     The average customer satisfaction rating.
      # @!attribute [rw] average_qa_normalized_score
      #   @return [::Float]
      #     Average QA normalized score.
      #     Will exclude 0's in average calculation.
      # @!attribute [rw] qa_tag_scores
      #   @return [::Array<::Google::Cloud::ContactCenterInsights::V1::QueryMetricsResponse::Slice::DataPoint::ConversationMeasure::QaTagScore>]
      #     Average QA normalized score for all the tags.
      # @!attribute [rw] average_qa_question_normalized_score
      #   @return [::Float]
      #     Average QA normalized score averaged for questions averaged across
      #     all revisions of the parent scorecard.
      #     Will be only populated if the request specifies a dimension of
      #     QA_QUESTION_ID.
      class ConversationMeasure
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods

        # Average QA normalized score for the tag.
        # @!attribute [rw] tag
        #   @return [::String]
        #     Tag name.
        # @!attribute [rw] average_tag_normalized_score
        #   @return [::Float]
        #     Average tag normalized score per tag.
        class QaTagScore
          include ::Google::Protobuf::MessageExts
          extend ::Google::Protobuf::MessageExts::ClassMethods
        end
      end
    end

    # A time series of metric values.
    # @!attribute [rw] data_points
    #   @return [::Array<::Google::Cloud::ContactCenterInsights::V1::QueryMetricsResponse::Slice::DataPoint>]
    #     The data points that make up the time series .
    class TimeSeries
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end
end

#update_time ⇒ ::Google::Protobuf::Timestamp

Returns The metrics last update time.

Returns:



1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
 
# File 'proto_docs/google/cloud/contactcenterinsights/v1/contact_center_insights.rb', line 1564

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

  # A slice contains a total and (if the request specified a time granularity)
  # a time series of metric values. Each slice contains a unique combination of
  # the cardinality of dimensions from the request.
  #
  # For example, if the request specifies a single ISSUE dimension and it has a
  # cardinality of 2 (i.e. the data used to compute the metrics has 2 issues in
  # total), the response will have 2 slices:
  #
  # * Slice 1 -> dimensions=[Issue 1]
  # * Slice 2 -> dimensions=[Issue 2]
  # @!attribute [rw] dimensions
  #   @return [::Array<::Google::Cloud::ContactCenterInsights::V1::Dimension>]
  #     A unique combination of dimensions that this slice represents.
  # @!attribute [rw] total
  #   @return [::Google::Cloud::ContactCenterInsights::V1::QueryMetricsResponse::Slice::DataPoint]
  #     The total metric value. The interval of this data point is
  #     [starting create time, ending create time) from the request.
  # @!attribute [rw] time_series
  #   @return [::Google::Cloud::ContactCenterInsights::V1::QueryMetricsResponse::Slice::TimeSeries]
  #     A time series of metric values. This is only populated if the request
  #     specifies a time granularity other than NONE.
  class Slice
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # A data point contains the metric values mapped to an interval.
    # @!attribute [rw] conversation_measure
    #   @return [::Google::Cloud::ContactCenterInsights::V1::QueryMetricsResponse::Slice::DataPoint::ConversationMeasure]
    #     The measure related to conversations.
    # @!attribute [rw] interval
    #   @return [::Google::Type::Interval]
    #     The interval that this data point represents.
    #
    #     * If this is the total data point, the interval is
    #     [starting create time, ending create time) from the request.
    #     * If this a data point from the time series, the interval is
    #     [time, time + time granularity from the request).
    class DataPoint
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # The measure related to conversations.
      # @!attribute [rw] conversation_count
      #   @return [::Integer]
      #     The conversation count.
      # @!attribute [rw] average_silence_percentage
      #   @return [::Float]
      #     The average silence percentage.
      # @!attribute [rw] average_duration
      #   @return [::Google::Protobuf::Duration]
      #     The average duration.
      # @!attribute [rw] average_turn_count
      #   @return [::Float]
      #     The average turn count.
      # @!attribute [rw] average_agent_sentiment_score
      #   @return [::Float]
      #     The average agent's sentiment score.
      # @!attribute [rw] average_client_sentiment_score
      #   @return [::Float]
      #     The average client's sentiment score.
      # @!attribute [rw] average_customer_satisfaction_rating
      #   @return [::Float]
      #     The average customer satisfaction rating.
      # @!attribute [rw] average_qa_normalized_score
      #   @return [::Float]
      #     Average QA normalized score.
      #     Will exclude 0's in average calculation.
      # @!attribute [rw] qa_tag_scores
      #   @return [::Array<::Google::Cloud::ContactCenterInsights::V1::QueryMetricsResponse::Slice::DataPoint::ConversationMeasure::QaTagScore>]
      #     Average QA normalized score for all the tags.
      # @!attribute [rw] average_qa_question_normalized_score
      #   @return [::Float]
      #     Average QA normalized score averaged for questions averaged across
      #     all revisions of the parent scorecard.
      #     Will be only populated if the request specifies a dimension of
      #     QA_QUESTION_ID.
      class ConversationMeasure
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods

        # Average QA normalized score for the tag.
        # @!attribute [rw] tag
        #   @return [::String]
        #     Tag name.
        # @!attribute [rw] average_tag_normalized_score
        #   @return [::Float]
        #     Average tag normalized score per tag.
        class QaTagScore
          include ::Google::Protobuf::MessageExts
          extend ::Google::Protobuf::MessageExts::ClassMethods
        end
      end
    end

    # A time series of metric values.
    # @!attribute [rw] data_points
    #   @return [::Array<::Google::Cloud::ContactCenterInsights::V1::QueryMetricsResponse::Slice::DataPoint>]
    #     The data points that make up the time series .
    class TimeSeries
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end
end