Version 2.4.7.20261116085428 · latest

Bot stats bot-stats

Stats at the top of the bot management page and the per-class "requests today" column: today's requests, requests and action breakdown per bot class, number of sites with replay protection on, and node upgrade progress; tenants see their own sites only.

Pick an endpoint to see its example call on the right.

ProtectionAuthentication: User (some parameters admin only)1 endpoints

Authentication

Send the X-API-Key header (create a key on the API Keys page; the key is shown only once at creation). An Authorization: Bearer token obtained by logging in also works.

X-API-Key

Authentication failures return 401; forbidden returns 403 (code such as insufficient_scope).

Conventions

Paging uses page (from 1) and page_size; sort with sort=field or sort=-field.

Times are RFC 3339 (UTC); amounts are in cents.

Writes return 200/201/204 on success; duplicates of a unique key return 409.

GET/api/v2/bot-statsGet bot stats

Authentication: User (some parameters admin only)

Query parameters

FieldTypeDescription
site_idinteger Count this site only; omit for all sites.

Bot stats object

FieldTypeDescription
classesBotClassStat[] Bot classes seen today with their action breakdown, in fixed class order (search, monitor, automation, ai, headless, malicious, fake); classes not seen today are omitted; empty when the log database is unavailable.
node_upgradeBotNodeUpgrade Node upgrade progress - approved nodes whose reported version matches this master; visible to admins only, omitted from tenant responses.
replay_sitesBotReplaySites Replay protection coverage.
today_requestsinteger All requests today; null when the log database is unavailable.

Responses and errors

Success returns the resource JSON directly (HTTP 2xx); failures return application/problem+json (code, detail, plus errors on validation failures); lists carry items + total.

Success
{
  "id": 1,
  "name": "example"
}
List
{
  "items": [
    {
      "id": 1
    }
  ],
  "page": 1,
  "page_size": 20,
  "total": 1
}
Error
{
  "code": "validation_failed",
  "detail": "Invalid request parameters",
  "errors": [
    {
      "code": "required",
      "field": "/name",
      "message": "name is required"
    }
  ],
  "request_id": "0123456789abcdef",
  "status": 422,
  "title": "Unprocessable Entity",
  "type": "about:blank"
}
Get started

Try the live demo

Open the live demo, or contact us for a quote and the install command