API reference

Analytics

Traffic to an organization's deployments.

GET/v1/orgs/:orgId/analytics

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

Auth: A person's token or an API key, as Authorization: Bearer.
Scope: analytics:read

Get an API key

Path parameters

orgId
Organization id (org_…).

Query parameters

range"24h" | "7d" | "30d" | "90d"
Default "24h".
projectIdstring
Matches ^prj_[0-9a-z]{10,40}$.

Errors

404Serverless App Service not found

curl 'https://api.cactive.com.au/v1/orgs/{orgId}/analytics' \
  -H "Authorization: Bearer $CACTIVE_TOKEN"

Send it from this page with your session or a key.

Response 200

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