Method: projects.locations.queryPerformanceOverview

Generates a summary of predefined performance metrics for a set of conversations. Conversations can be specified by specifying a time window and an agent id, for now. The summary includes a comparison of metrics computed for conversations in the previous time period, and also a comparison with peers in the same time period.

HTTP request

POST https://{endpoint}/v1alpha1/{parent=projects/*/locations/*}:queryPerformanceOverview

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

The URLs use gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The parent resource of the conversations to derive performance stats from. "projects/{project}/locations/{location}"

Request body

The request body contains data with the following structure:

JSON representation 
{
  "filter": string,
  "queryInterval": {
    object (QueryInterval)
  },

  // Union field source can be only one of the following:
  "agentPerformanceSource": {
    object (AgentSource)
  }
  // End of list of possible types for union field source.
  "comparisonQueryInterval": {
    object (QueryInterval)
  }
}
Fields
filter

string

Optional. Filter to select a subset of conversations to compute the performance overview. Supports the same filters as the filter field in QueryMetricsRequest. The source and query interval/comparison query interval should not be included here.
queryInterval

object (QueryInterval)

Required. The time window of the conversations to derive performance stats from.
Union field source. The type of source of conversations to derive performance from. source can be only one of the following:
agentPerformanceSource

object (AgentSource)

Conversations are from a single agent.
comparisonQueryInterval

object (QueryInterval)

The time window of the conversations to compare the performance to.

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 permissions on the parent resource:

  • contactcenterinsights.authorizedConversations.list
  • contactcenterinsights.conversations.list

For more information, see the IAM documentation.