Traffic Analytics

Get server-wide traffic overview

Changed on

Request/bandwidth totals, status-class counts, latency percentiles, and estimated unique visitors merged across every app and host on the box. Sketches (t-digest, HyperLogLog) are merged server-side, so the percentiles and visitor estimate are a true cross-app merge, not a sum of per-app estimates. Same shape as the per-app overview.

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

get/api/traffic/overview

Request

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

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.

Response

Server-wide traffic overview

bytes_ininteger required
bytes_outinteger required
requestsinteger required
unique_visitorsinteger required

Approximate distinct client IPs (HyperLogLog++ estimate, ~1-2% error).

Changes

  • dbee64925479Revision changes
    • 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

    • breaking

      the / response's property format changed from float to double for status

    • breaking

      the / response's property format changed from float to double for status

    • breaking

      the / response's property format changed from float to double for status

    • info

      api operation id server_overview 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 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

    • 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

    • 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

    • 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

    • info

      the response property became required for the status

  • ba1ba2f4b919Revision changes
    • info

      endpoint added