latestOpenAPI 3.0.3Apache-2.0raw.githubusercontent.com2026-08-21252044.5 KB

b29311671936

Traffic Analytics

Get aggregate traffic dashboard (per app)

Per-app variant of GET /api/traffic/dashboard: every member filtered to one app, and apps omitted entirely. apps_limit is ignored.

get/api/app/{uuid}/traffic/dashboard

Path parameters

uuidstring required

Coolify app UUID (or host, for Caddy — see README.md)

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.

range'24h' | '7d' | '30d'

Time window and bucket granularity for a series. 24h yields 24 hourly buckets; 7d/30d yield 7/30 daily buckets. Defaults to 24h.

paths_limitinteger

Top-N cap for the dashboard's paths. Defaults to 50, capped at 1000.

breakdown_limitinteger

Top-N cap per dashboard breakdown dimension. Defaults to 50, capped at 1000.

Response

Aggregate dashboard for one app (no leaderboard)

attributionstring nullable

The active GeoIP source's attribution string, or null.

Example response

{
  "overview": {
    "requests": 128340,
    "bytes_in": 15200000,
    "bytes_out": 981000000,
    "status": {
      "s2xx": 124000,
      "s3xx": 3200,
      "s4xx": 1100,
      "s5xx": 40
    },
    "latency": {
      "p50": 42,
      "p95": 210.5,
      "p99": 480
    },
    "unique_visitors": 8421
  },
  "paths": [
    {
      "path": "/api/checkout",
      "app": "jc4wsgs",
      "requests": 5210,
      "bytes_out": 41200000,
      "p50": 38,
      "p95": 190
    }
  ],
  "breakdowns": {
    "country": [
      {
        "value": "US",
        "requests": 42000,
        "bytes_out": 320000000
      }
    ],
    "referer": [
      {
        "value": "US",
        "requests": 42000,
        "bytes_out": 320000000
      }
    ],
    "browser": [
      {
        "value": "US",
        "requests": 42000,
        "bytes_out": 320000000
      }
    ],
    "os": [
      {
        "value": "US",
        "requests": 42000,
        "bytes_out": 320000000
      }
    ],
    "device": [
      {
        "value": "US",
        "requests": 42000,
        "bytes_out": 320000000
      }
    ],
    "protocol": [
      {
        "value": "US",
        "requests": 42000,
        "bytes_out": 320000000
      }
    ],
    "cache": [
      {
        "value": "US",
        "requests": 42000,
        "bytes_out": 320000000
      }
    ],
    "status": [
      {
        "value": "US",
        "requests": 42000,
        "bytes_out": 320000000
      }
    ],
    "agent": [
      {
        "value": "US",
        "requests": 42000,
        "bytes_out": 320000000
      }
    ],
    "ip": [
      {
        "value": "US",
        "requests": 42000,
        "bytes_out": 320000000
      }
    ],
    "useragent": [
      {
        "value": "US",
        "requests": 42000,
        "bytes_out": 320000000
      }
    ]
  },
  "series": [
    {
      "bucket": 1723334400000,
      "requests": 46,
      "bytes_in": 12800,
      "bytes_out": 402000,
      "s2xx": 42,
      "s3xx": 3,
      "s4xx": 1,
      "unique_visitors": 37,
      "p95": 118
    }
  ],
  "attribution": "This product includes GeoLite2 data created by MaxMind, available from https://www.maxmind.com",
  "apps": [
    {
      "uuid": "jc4wsgs",
      "overview": {
        "requests": 128340,
        "bytes_in": 15200000,
        "bytes_out": 981000000,
        "status": {
          "s2xx": 124000,
          "s3xx": 3200,
          "s4xx": 1100,
          "s5xx": 40
        },
        "latency": {
          "p50": 42,
          "p95": 210.5,
          "p99": 480
        },
        "unique_visitors": 8421
      }
    }
  ]
}