ba1ba2f4b919

latestOpenAPI 3.0.3Apache-2.0raw.githubusercontent.com2026-08-10211632.9 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.

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
  }
]