Traffic Analytics

Get server-wide dimension breakdown

Changed on

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.

Requires Sentinel built with the traffic Cargo feature AND TRAFFIC_ENABLED=true at runtime; returns 404 otherwise.

get/api/traffic/breakdown/{dimension}

Request

  • The document declares no server URL.
  • Auth: HTTP bearer

Path parameters

dimensionstring required

One of: status, method, country, city, 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

Start date in ISO 8601 format (UTC). Defaults to the Unix epoch (all recorded history) when omitted.

tostring

End date in ISO 8601 format (UTC). Defaults to now when omitted.

limitstring

A String, not a usize, so ?limit= (empty) can be treated as absent rather than rejected by the extractor — the same courtesy resolve_range extends to ?from=.

Positive integer, max 1000. Defaults to 50.

Response

Top values of the dimension across all apps

bytes_outinteger required
latnumber double
lonnumber double
requestsinteger required
valuestring required

Changes

  • 5cf32a76eb5aRevision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

  • dbee64925479Revision changes
    • breaking

      for the query request parameter limit, default value 50 was removed

    • breaking

      removed the media type application/json for the response with the status

    • breaking

      removed the media type application/json for the response with the status

    • breaking

      removed the media type application/json for the response with the status

    • breaking

      removed the media type application/json for the response with the status

    • info

      api operation id server_breakdown was added

    • info

      the endpoint scheme security bearerAuth was added to the API

    • info

      for the query request parameter from, the format was generalized from date-time to no format

    • info

      for the query request parameter limit, the type was generalized from integer to string

    • info

      for the query request parameter to, the format was generalized from date-time to no format

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status