Skip to content

Retrieves a zone-kpis resource.

GET
/api/zones/{zoneId}/traffic-summary

Retrieves a zone-kpis resource.

Authorizations

ApiToken

Long-lived API token created via POST /api/api-tokens (returned once in plaintext).

Type
API Key (header: X-API-TOKEN)
or
JWT

JWT access token obtained via POST /api/auth/login. Send as: Authorization: Bearer .

Type
HTTP (bearer)

Parameters

Path Parameters

zoneId*

Zone identifier

Type
string
Required

Query Parameters

from

Window start (Unix seconds). Both from and to must be given; otherwise a rolling 7-day window is used. Note: bandwidth is aggregated daily, so sub-day windows report day-granular bytes.

Type
integer
to

Window end (Unix seconds).

Type
integer

Responses

zone-kpis resource

JSON
{
  
"@context": "string",
  
"@id": "string",
  
"@type": "string",
  
"requests": {
  
  
"total": 0,
  
  
"change": 0
  
},
  
"imageHits": {
  
  
"total": 0,
  
  
"change": 0
  
},
  
"htmlHits": {
  
  
"total": 0,
  
  
"change": 0
  
},
  
"blockedRequests": {
  
  
"total": 0,
  
  
"change": 0
  
},
  
"totalBytesSentMb": {
  
  
"total": 0,
  
  
"change": 0
  
}
}

Playground

Authorization
Variables
Key
Value

Samples

Powered by VitePress OpenAPI