Get local leaderboard

curl --request GET \
  --url https://api.closebot.com/botMetric/localleaderboard \
  --header 'X-CB-KEY: <api-key>'

[
  {
    "agencyName": "<string>",
    "count": 123
  }
]

GET

botMetric

localleaderboard

Get local leaderboard

curl --request GET \
  --url https://api.closebot.com/botMetric/localleaderboard \
  --header 'X-CB-KEY: <api-key>'

[
  {
    "agencyName": "<string>",
    "count": 123
  }
]

X-CB-KEY

string

header

required

CloseBot API Key Authorization

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.

numSurroundingAgencies

integer<int32>

The number of surrounding agencies to return.

Success

agencyName

string | null

The name of the agency

count

integer<int32>

The number of the metric