f939ccc82c4e

OpenAPI 3.0.3Apache-2.0raw.githubusercontent.com2026-08-12231737.0 KB

Traffic Analytics

Get server-wide dimension breakdown

Top values of one dimension across every app on the box, summed over the range. An unrecognized dimension returns an empty array, not an error.

get/api/traffic/breakdown/{dimension}

Path parameters

dimensionstring required

One of: status, method, country, referer, browser, os, device, protocol, scheme, tls, cache, bot, agent, ip, useragent. The agent dimension holds the bot/AI-agent name (e.g. GPTBot, ClaudeBot) and is only present for bot traffic. ip holds the resolved real client IP (respecting Cloudflare CF-Connecting-IP and X-Forwarded-For); useragent holds the raw User-Agent header.

Query parameters

fromstring date-time

Start date in ISO 8601 format (UTC timezone). If not provided, defaults to 1970-01-01T00:00:00Z.

tostring date-time

End date in ISO 8601 format (UTC timezone). If not provided, defaults to current time.

limitinteger

Number of ranked entries to return, applied after summing across buckets. Defaults to 50, capped at 1000.

Response

Top values of the dimension across all apps

valuestring

requestsinteger

bytes_outinteger

Example response

[
  {
    "value": "US",
    "requests": 42000,
    "bytes_out": 320000000
  }
]