Sign in

v1

latestOpenAPI 3.1.02026-07-2687120159.0 KB

Get distribution of the maximum number of concurrent conversations

Returns the maximum number of concurrent conversations in several 5-minute intervals based on the given parameters.

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

Path parameters

account_idstring required
Example:ACCOUNT-t53y16r3

Account ID.

project_idstring required
Example:PROJECT-f76d75c2

Project ID.

Query parameters

start_timestring date-time required

Start of the time range in ISO8601 format. Rounded down to the nearest 5-minute datetime. start_time and end_time must be no more than 1 week apart.

end_timestring date-time required

End of the time range in ISO8601 format. Rounded up to the nearest 5-minute datetime. start_time and end_time must be no more than 1 week apart.

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

If set, only include conversations in this environment. Can be sandbox, pre-release or live.

variant_namestring

If set, only include conversations under this variant name. You may specify either variant_id or variant_name, not both. Encode spaces as "%20".

variant_idstring

If set, only include conversations under this variant ID. You may specify either variant_id or variant_name, not both.

languagestring

If set, only include conversations in this language.

phone_numberstring

If set, only include conversations for this phone number.

slice_bystring

If set, slice the result intervals based on this parameter. You can slice by variant, language or phone_number. Currently language and phone_number slicing are not implemented (501).

Response

OK.

account_idstring required

Customer PolyAI Account ID.

project_idstring required

Customer PolyAI Project ID.

Example response

{
  "account_id": "ACCOUNT-t53y16r3",
  "project_id": "PROJECT-f76d75c2",
  "intervals": [
    {
      "time": "2022-04-01T16:35:00.000Z",
      "max_concurrent_conversations": 25,
      "variant_id": "satdt",
      "variant_name": "variant_1",
      "language": "en-GB",
      "phone_number": "+447856838428"
    }
  ]
}