Skip to main content
GET
Bot 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

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"

type
enum<string>

What the summary is scoped to.

Available options:
account,
agent,
inbox,
label,
team
Example:

"account"

id
integer

The agent, inbox, label or team to scope to, when type is not account.

Response

Success

Bot resolution and handoff counts for the period, with the immediately preceding period of the same length for comparison.

bot_resolutions_count
integer

Conversations the bot resolved in the period.

bot_handoffs_count
integer

Conversations the bot handed to a human in the period.

previous
object

The same two counts for the period of equal length immediately before this one.