Sign in

v1

latestOpenAPI 3.1.02026-07-2687120159.0 KB

Returns all conversations matching filters.

get/v1/{account_id}/{project_id}/conversations

Path parameters

account_idstring required

Account ID.

project_idstring required

Project ID.

Query parameters

client_env'sandbox' | 'pre-release' | 'live'

Client environment – sandbox, pre-release or live.

start_timestring date-time

Start of the time range of the conversations to get, in ISO8601 format.

end_timestring date-time

End of the time range of the conversations to get, in ISO8601 format.

limitinteger

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

offsetinteger

Offset within the result set to fetch.

variant_idstring

Return all conversations under this variant_id. You may specify either variant_id or variant_name, not both.

variant_namestring

Return all conversations under this variant_name. You may specify either variant_id or variant_name. Encode spaces as "%20".

in_progressboolean

If false, only return finished conversations. If true, only return conversations still in progress. If omitted, return all conversations.

Response

OK.

next_offsetinteger

If present, the result is paginated. Pass this value as offset in the next request to fetch the next page.

Example response

{
  "conversations": [
    {
      "id": "CAabcd1234567abcdef1250065d4fc7389",
      "metrics": {
        "CALL_DURATION": "30",
        "CALL_TURN": [
          "2022-02-18T12:09:05.12677Z",
          "2022-02-18T12:09:17.90602Z",
          "2022-02-18T12:09:29.57732Z",
          "2022-02-18T12:09:35.36996Z"
        ]
      }
    }
  ]
}