Traffic Analytics

Get resource traffic overview

Changed on

Per-resource variant of the app overview. Counters are summed, unique visitor HyperLogLog++ sketches are unioned (a visitor on two keys counts once), and latency t-digests are merged. A resource with no data in range returns 200 with every counter zeroed.

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/overview

Request

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

Path parameters

uuidstring required

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

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

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

  • 52fca5d9e920Revision changes
    • info

      endpoint added