Skip to main content
GET
Label summary report

Authorizations

api_access_token
string
header
required

This token can be obtained by visiting the profile page or via rails console. Provides access to endpoints based on the user permissions levels. This token can be saved by an external system when user is created via API, to perform activities on behalf of the user.

Path Parameters

id
integer
required

The numeric ID of the account

Query Parameters

since
string
required

Start of the reporting period, as Unix epoch seconds. Required.

Example:

"1787369963"

until
string
required

End of the reporting period, as Unix epoch seconds. Required.

Example:

"1789961963"

business_hours
boolean

Measure the time metrics against the inbox's configured business hours instead of wall-clock time.

Response

Success

id
integer

The agent, team, inbox or label this row is for.

name
string

Present on the label report only; the other three identify the row by id alone.

conversations_count
integer

Conversations in the period.

resolved_conversations_count
integer

How many of them were resolved.

avg_resolution_time
number | null

Mean seconds from first message to resolution.

avg_first_response_time
number | null

Mean seconds to the first agent reply.

avg_reply_time
number | null

Mean seconds between a contact message and the agent reply that followed it.

incoming_messages_count
integer

Inbox report only — messages received.

outgoing_messages_count
integer

Inbox report only — messages sent.