Skip to main content
GET
/
botMetric
/
leaderboard
Get global leaderboard
curl --request GET \
  --url https://api.closebot.com/botMetric/leaderboard \
  --header 'X-CB-KEY: <api-key>'
[
  {
    "agencyName": "<string>",
    "count": 123
  }
]

Authorizations

​
X-CB-KEY
string
header
required

CloseBot API Key Authorization

Query Parameters

​
metric
string

The metric to get. Valid options: responses, bookings, contacts.

​
start
string<date-time>

The start date.

​
end
string<date-time>

The end date.

​
numTopLeaders
integer<int32>

The number of top leaders to return.

Response

Success

​
agencyName
string | null

The name of the agency

​
count
integer<int32>

The number of the metric