Method: projects.locations.conversations.analyses.list

Lists analyses.

HTTP request

GET https://{endpoint}/v1/{parent=projects/*/locations/*/conversations/*}/analyses

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

Query parameters

Parameters
pageSize

integer

The maximum number of analyses to return in the response. If this value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty nextPageToken in the response indicates that more data is available.
pageToken

string

The value returned by the last ListAnalysesResponse; indicates that this is a continuation of a prior analyses.list call and the system should return the next page of data.
filter

string

A filter to reduce results to a specific subset. Useful for querying conversations with specific properties.

Request body

The request body must be empty.

Response body

The response to list analyses.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "analyses": [
    {
      object (Analysis)
    }
  ],
  "nextPageToken": string
}
Fields
analyses[]

object (Analysis)

The analyses that match the request.
nextPageToken

string

A token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.

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.authorizedAnalyses.list
  • contactcenterinsights.analyses.list

For more information, see the IAM documentation.