- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- IAM Permissions
- TimeSeries
- Interval
- Try it!
Gets conversation statistics.
HTTP request
GET https://{endpoint}/v1alpha1/{location=projects/*/locations/*}/conversations:calculateStats
Where {endpoint}
is one of the supported service endpoints.
The URLs use gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
location |
Required. The location of the conversations. |
Query parameters
Parameters | |
---|---|
filter |
A filter to reduce results to a specific subset. This field is useful for getting statistics about conversations with specific properties. |
Request body
The request body must be empty.
Response body
The response for calculating conversation statistics.
If successful, the response body contains data with the following structure:
JSON representation |
---|
{ "averageDuration": string, "averageTurnCount": integer, "conversationCount": integer, "smartHighlighterMatches": { string: integer, ... }, "customHighlighterMatches": { string: integer, ... }, "issueMatches": { string: integer, ... }, "issueMatchesStats": { string: { object ( |
Fields | |
---|---|
averageDuration |
The average duration of all conversations. The average is calculated using only conversations that have a time duration. A duration in seconds with up to nine fractional digits, ending with ' |
averageTurnCount |
The average number of turns per conversation. |
conversationCount |
The total number of conversations. |
smartHighlighterMatches |
A map associating each smart highlighter display name with its respective number of matches in the set of conversations. An object containing a list of |
customHighlighterMatches |
A map associating each custom highlighter resource name with its respective number of matches in the set of conversations. An object containing a list of |
issueMatches |
A map associating each issue resource name with its respective number of matches in the set of conversations. Key has the format: An object containing a list of |
issueMatchesStats |
A map associating each issue resource name with its respective number of matches in the set of conversations. Key has the format: An object containing a list of |
conversationCountTimeSeries |
A time series representing the count of conversations created over time that match that requested filter criteria. |
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 permission on the location
resource:
contactcenterinsights.conversations.list
For more information, see the IAM documentation.
TimeSeries
A time series representing conversations over time.
JSON representation |
---|
{
"intervalDuration": string,
"points": [
{
object ( |
Fields | |
---|---|
intervalDuration |
The duration of each interval. A duration in seconds with up to nine fractional digits, ending with ' |
points[] |
An ordered list of intervals from earliest to latest, where each interval represents the number of conversations that transpired during the time window. |
Interval
A single interval in a time series.
JSON representation |
---|
{ "startTime": string, "conversationCount": integer } |
Fields | |
---|---|
startTime |
The start time of this interval. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
conversationCount |
The number of conversations created in this interval. |