Skip to main content
GET
/
botMetric
/
agencySummary
Get agency summary
curl --request GET \
  --url https://api.closebot.com/botMetric/agencySummary \
  --header 'X-CB-KEY: <api-key>'
{
  "currentMonthMessageCount": 123,
  "lastMonthMessageCount": 123,
  "totalStorage": 123,
  "currentMonthSuccessfulBookings": 123,
  "lastMonthSuccessfulBookings": 123,
  "currentMonthActiveSources": 123,
  "lastMonthActiveSources": 123,
  "currentUsers": 123,
  "currentMonthContacts": 123,
  "lastMonthContacts": 123,
  "currentMonthRespondedContacts": 123,
  "currentMonthFollowUpsFromNoResponse": 123,
  "currentMonthFollowUpsFromResponded": 123
}

Authorizations

​
X-CB-KEY
string
header
required

CloseBot API Key Authorization

Query Parameters

​
sourceId
string

Optional source ID.

Response

Success

​
currentMonthMessageCount
integer<int32>

The number of messages sent to leads in the current month

​
lastMonthMessageCount
integer<int32>

The number of messages sent to leads in the last month

​
totalStorage
number<double>

The total storage used by the agency

​
currentMonthSuccessfulBookings
integer<int32>

The number of successful bookings in the current month

​
lastMonthSuccessfulBookings
integer<int32>

The number of successful bookings in the last month

​
currentMonthActiveSources
integer<int32>

The number of active sources in the current month

​
lastMonthActiveSources
integer<int32>

The number of active sources in the last month

​
currentUsers
integer<int32>

The number of users in the current month

​
currentMonthContacts
integer<int32>

The number of leads in the current month

​
lastMonthContacts
integer<int32>

The number of leads in the last month

​
currentMonthRespondedContacts
integer<int32>

Distinct leads who sent at least one inbound message this month

​
currentMonthFollowUpsFromNoResponse
integer<int32>

Current-month contacts with no response that have a follow-up scheduled

​
currentMonthFollowUpsFromResponded
integer<int32>

Current-month contacts that responded (no booking) with a follow-up scheduled