Traffic Analytics

Get resource dimension breakdown

Changed on

Per-resource variant of the app dimension breakdown, merged by value across every key of the resource.

Reads the key {uuid} and every key that starts with {uuid}- (Compose services, previews, Compose previews). A key such as {uuid}x… (no dash) is not included.

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

get/api/resource/{uuid}/traffic/breakdown/{dimension}

Request

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

Path parameters

uuidstring required

Coolify resource UUID. Matched literally (% and _ are not wildcards).

dimensionstring required

One of: status, method, country, city, referer, browser, os, device, protocol, scheme, tls, cache, bot, agent, ip, useragent. An unrecognized dimension returns an empty array, not an error.

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 for the resource

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 resource_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