Skip to main content
GET
/
v1
/
{account_id}
/
{project_id}
/
conversations
/
concurrency
Get distribution of the maximum number of concurrent conversations
curl --request GET \
  --url https://api.us-1.platform.polyai.app/v1/{account_id}/{project_id}/conversations/concurrency \
  --header 'x-api-key: <api-key>'
{
  "account_id": "ACCOUNT-t53y16r3",
  "project_id": "PROJECT-f76d75c2",
  "intervals": [
    {
      "variant_id": "satdt",
      "variant_name": "variant_1",
      "language": "en-GB",
      "time": "2022-04-01T16:35:00Z",
      "max_concurrent_conversations": 25
    },
    {
      "variant_id": "satdt",
      "variant_name": "variant_1",
      "language": "en-US",
      "time": "2022-04-01T16:40:00Z",
      "max_concurrent_conversations": 20
    },
    {
      "variant_id": "satdc",
      "variant_name": "variant_2",
      "language": "en-GB",
      "time": "2022-04-01T16:35:00Z",
      "max_concurrent_conversations": 5
    }
  ]
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
account_id
string
required

Account ID.

Example:

"ACCOUNT-t53y16r3"

​
project_id
string
required

Project ID.

Example:

"PROJECT-f76d75c2"

Query Parameters

​
start_time
string<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_time
string<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
enum<string>
default:live

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

Available options:
sandbox,
pre-release,
live
​
variant_name
string

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_id
string

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

​
language
string

If set, only include conversations in this language.

​
phone_number
string

If set, only include conversations for this phone number.

​
slice_by
string

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_id
string
required

Customer PolyAI Account ID.

Example:

"ACCOUNT-t53y16r3"

​
project_id
string
required

Customer PolyAI Project ID.

Example:

"PROJECT-f76d75c2"

​
intervals
object[]
required

Array of intervals returned in ascending chronological order.