API reference

Analytics

Traffic to an organization's deployments.

`GET /v1/orgs/:orgId/analytics`

Traffic to the organization's deployments, or to one project's with projectId, over the last 24h, 7d or 30d.

Auth: user access token or platform agent key · Scope: analytics:read

Path parameter	Description
`:orgId`	Organization id (`org_…`).

Query parameter	Type	Required	Default	Notes
`range`	`"24h" \| "7d" \| "30d"`	No	`"24h"`
`projectId`	`string`	No		matches `^prj_[0-9a-z]{10,40}$`

Response 200

{
  top: {
    hosts?: {
      key: string
      requests: number
      bytes: number
      name?: string
    }[]
    orgs?: {
      key: string
      requests: number
      bytes: number
      name?: string
    }[]
    paths?: {
      key: string
      requests: number
      bytes: number
      name?: string
    }[]
    countries?: {
      key: string
      requests: number
      bytes: number
      name?: string
    }[]
    deployments?: {
      key: string
      requests: number
      bytes: number
      name?: string
    }[]
    projects?: {
      key: string
      requests: number
      bytes: number
      name?: string
    }[]
  }
  updatedAt: null | number
  range: "24h" | "7d" | "30d"
  step: number
  from: string
  to: string
  totals: {
    requests: number
    bytes: number
    s2xx: number
    s3xx: number
    s4xx: number
    s5xx: number
    hits: number
    misses: number
    p50: null | number
    p95: null | number
  }
  series: {
    requests: number
    bytes: number
    s2xx: number
    s3xx: number
    s4xx: number
    s5xx: number
    hits: number
    misses: number
    p50: null | number
    p95: null | number
    t: string
  }[]
}

Errors

Status	Message
`404`	Project not found