Skip to main content
GET
Get Account reports summary

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

type
enum<string>
required

Type of report

Available options:
account,
agent,
inbox,
label,
team
id
string

The Id of specific object in case of agent/inbox/label

since
string

The timestamp from where report should start.

until
string

The timestamp from where report should stop.

Response

Success

avg_first_response_time
string | null

Mean seconds to the first agent reply. Null when nothing in the period could be measured.

avg_resolution_time
string | null

Mean seconds from first message to resolution. Null when nothing could be measured.

conversations_count
number

Conversations in the period.

incoming_messages_count
number

Messages received from contacts.

outgoing_messages_count
number

Messages sent by agents and bots.

resolutions_count
number

Conversations resolved in the period.

previous
object

The same six figures for the period of equal length immediately before this one, so a trend needs one call rather than two.