Skip to main content
POST
Queued visitors left
Required scopes: reports_read

Authorizations

Authorization
string
header
required

Use your account ID as the username and your personal access token (PAT) as the password, or pass a Base64-encoded value directly in the Authorization header. For more information, see the personal access tokens guide.

Body

application/json
distribution
enum<string>
default:day

The time distribution of results.

Available options:
hour,
day,
day-hours,
month,
year
timezone
string

The IANA Time Zone identifier (for example, America/Phoenix). By default, the timezone is taken from the request. If not provided, it's taken from the agent's timezone. When the agent's timezone cannot be determined, filters.from is used to derive it.

filters
object

Filters for chats reports. If none provided, the report spans the last seven days. If filters are provided, they must contain exactly one pair of time-based filters (from/to, greetings.from/to, or surveys.from/to).

page
integer
default:1

A non-negative integer for result pagination.

Required range: x >= 0

Response

200 - application/json

OK.

total
integer

The total number of chats in the specified date range.

summary
object

A report summary.

records
object

A map of records keyed by chat ID. Each value contains information about visitors who abandoned the queue.