Method: projects.locations.conversations.list

Lists conversations.

HTTP request

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

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

Query parameters

Parameters
virtualAgentId

string

The agent id of the Dialogflow conversation. It is specified to only list the conversations under this agent.
pageSize

integer

The maximum number of conversations to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size.
pageToken

string

The value returned by the last ListConversationsResponse. This value indicates that this is a continuation of a prior conversations.list call and that 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.
orderBy

string

Optional. The attribute by which to order conversations in the response. If empty, conversations will be ordered by descending creation time. Supported values are one of the following:

  • createTime
  • customerSatisfactionRating
  • duration
  • latestAnalysis
  • startTime
  • turnCount

The default sort order is ascending. To specify order, append asc or desc (createTime desc). For more details, see Google AIPs Ordering.
view

enum (ConversationView)

The level of details of the conversation. Default is BASIC.

Request body

The request body must be empty.

Response body

The response of listing conversations.

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

JSON representation 
{
  "conversations": [
    {
      object (Conversation)
    }
  ],
  "nextPageToken": string
}
Fields
conversations[]

object (Conversation)

The conversations that match the request.
nextPageToken

string

A token which can be sent as pageToken to retrieve the next page. If this field is set, it means there is another page available. If it is not set, it means no other pages are available.

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 parent resource:

  • contactcenterinsights.conversations.list

For more information, see the IAM documentation.