List all conversations

Authorizations

x-api-key

string

header

required

Path Parameters

account_id

string

required

Account ID

project_id

string

required

Project ID

Query Parameters

client_env

enum<string>

default:

live

Client Environment - sandbox, pre-release or live

Available options:

sandbox,

pre-release,

live

start_time

string

The start of the time range of the conversations to get, in ISO8601 format

end_time

string

The end of the time range of the conversations to get, in ISO8601 format

limit

integer

default:

Max number of conversations to return per API call. If the result set of your query is larger than this, it will be paginated.

Required range: 1 < x < 5000

offset

integer

default:

Offset within result set to fetch.

Required range: x > 0

include_context_state

boolean

default:

false

If true, include the context_state for each conversation. This is a large, noisy dictionary of the agent's internal dialogue state at the end of the conversation.

variant_id

string

If it is set, we would return all conversations under this variant_id. Note that you may only specify either one of the variant_id or variant_name

variant_name

string

If it is set, we would return all conversations under this variant_name. Note that you may only specify either one of the variant_id or variant_name. Also, make sure to encode any spaces in the name with "%20"

in_progress

boolean

If it is set to false, we only return finished conversations. If it is set to true, we only return conversations still in progress. By default, this parameter is None and we return all conversations

Response

200 - application/json

conversations

object[]

An array of conversations returned in ascending chronological order.

conversations.account_id

string

required

ID of the customer account this conversation is under.

conversations.channel

string

required

What medium the conversation took place in. Usually one of CHAT or VOICE-SIP.

conversations.environment

string

required

Which deployment environment this conversation was handled in. Usually live, sandbox, or pre-release.

conversations.id

string

required

Unique ID for this conversation

conversations.in_progress

boolean

required

If true, the call is currently in progress, and therefore its properties may still change in the future.

conversations.project_id

string

required

ID of the project this conversation is under.

conversations.started_at

string

required

The time when the conversation began, in ISO8601 format.

conversations.from_number

string

Caller's phone number.

conversations.handoff

boolean

Whether or not the PolyAI agent handed the call off.

conversations.handoff_destination

string

If there are multiple handoff destinations, which one was used.

conversations.handoff_reason

string

Brief reason why the agent handed the call off.

conversations.metrics

object

Mapping name -> value of custom metrics logged by the agent. If a metric name was written more than once, the value will be a list of the values that were written.

conversations.num_ood

integer

Number of turns in the conversation where the caller gave some input, but it could not be understood by our agent.

conversations.num_silences

integer

Number of turns in the conversation where the caller gave no discernible input.

conversations.num_turns

integer

Number of turns in the conversation.

conversations.polyai_duration

integer

Duration of the portion of the call handled by the PolyAI agent, in seconds.

conversations.state

object

Mapping of keys -> values written to the dialogue state by the agent.

conversations.to_number

string

Phone number of the agent the caller was connected to.

conversations.total_duration

integer

Duration of the entire call, in seconds.

conversations.turns

object[]

Ordered list of turns in the conversation.

conversations.variant_id

string

ID of the variant this conversation is in

conversations.variant_name

string

Name of the variant this conversation is in

descriptions

object

An dictionary of response keys and their descriptions

next_offset

integer

If present, the result is being paginated and requires another API call to fetch the next portion (pass the provided next_offset as the offset param for the next API call).

API reference

Chat

Conversations

Authorizations

Path Parameters

Query Parameters

Response