Get max concurrent call numbers

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

Authorizations

x-api-key

string

header

required

Path Parameters

account_id

string

required

Account ID

project_id

string

required

Project ID

Query Parameters

start_time

string

required

The start of the time for the range of the intervals, in ISO8601 format This is rounded down to the nearest 5-min date-time. start_time and end_time shouldn't be more than 1 week apart

end_time

string

required

The end of the time for the range of the intervals, in ISO8601 format This is rounded up to the nearest 5-min date-time. start_time and end_time shouldn't be more than 1 week apart

client_env

enum<string>

default:

live

If it is set, we would return all conversations under this client_env. Client Environment can be sandbox, pre-release or live

Available options:

sandbox,

pre-release,

live

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"

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

language

string

If it is set, we would return all conversations under this language.

phone_number

string

If it is set, we would return all conversations under phone_number.

slice_by

string

If it is set, we slice the result intervals based on the slice_by parameter. You can slice by variant, language or phone_number. At the moment querying with slice_by=language or slice_by=phone_number will result in 501 Not Implemented

Response

200

application/json

OK

account_id

string

required

Customer PolyAI Account ID

project_id

string

required

Customer PolyAI Project ID

intervals

object[]

required

An array of intervals returned in ascending chronological order.

Show child attributes

intervals.time

string

required

The UTC lower bound time for this interval in ISO8601 format.

intervals.max_concurrent_conversations

integer

required

The maximum number of concurrent conversations in the 5-minute interval starting from time This is the number after slicing based on the rest of the query parameters

intervals.variant_id

string

The variant ID of for this interval. This is only present if the query is sliced by a <variant> using slice_by query parameter.

intervals.variant_name

string

The variant name for this interval. This is only present if the query is sliced by a <variant> using slice_by query parameter.

intervals.language

string

The variant name for this interval. This is only present if the query is sliced by a <language> using slice_by query parameter. This is still not implemented, and will not be visible in the current state of implementation.

intervals.phone_number

string

The variant name for this interval. This is only present if the query is sliced by a <phone_number> using slice_by query parameter. This is still not implemented, and will not be visible in the current state of implementation.