Retrieves the collection of traffic-log resources.

GET

/api/organizations/{organizationId}/traffic-logs

Retrieves the collection of traffic-log resources.

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

organizationId*

Organization identifier

Type

string

Required

Query Parameters

page

The collection page number

Type

integer

Default

1

itemsPerPage

The number of items per page

Type

integer

Default

30

Minimum

0

Maximum

100

from

Window start, unix seconds (default: 15 minutes before "to").

Type

integer

to

Window end, unix seconds (default: now).

Type

integer

zoneId

Restrict to these zones (must belong to the organization). Omit for all the org's zones.

Type

array

order[event_time]

Sort by event_time (default desc). Any field is sortable via order[].

Type

string

Valid values

"asc""desc"

status_code

Filter by status_code (also status_code[gte]/[lt]/…). Any raw field is filterable.

Type

integer

host

Filter by host (host[like]=… for substring).

Type

string

q

Case-insensitive substring search on host/uri/client_ip/request_id.

Type

string

Responses

traffic-log collection

Content-Type

{

  

"totalItems": 0,

  

"search": {

  

  

"@type": "string",

  

  

"template": "string",

  

  

"variableRepresentation": "string",

  

  

"mapping": [

  

  

  

{

  

  

  

  

"@type": "string",

  

  

  

  

"variable": "string",

  

  

  

  

"property": "string",

  

  

  

  

"required": true

  

  

  

}

  

  

]

  

},

  

"view": {

  

  

"@id": "string",

  

  

"@type": "string",

  

  

"first": "string",

  

  

"last": "string",

  

  

"previous": "string",

  

  

"next": "string"

  

},

  

"member": [

  

  

{

  

  

  

"event_time": "string",

  

  

  

"zone_id": "string",

  

  

  

"request_id": "string",

  

  

  

"host": "string",

  

  

  

"sni": "string",

  

  

  

"method": "string",

  

  

  

"protocol": "string",

  

  

  

"uri": "string",

  

  

  

"request_uri": "string",

  

  

  

"referer": "string",

  

  

  

"user_agent": "string",

  

  

  

"remote_user": "string",

  

  

  

"origin_status": "string",

  

  

  

"tls_version": "string",

  

  

  

"tls_cipher": "string",

  

  

  

"cache_status": "string",

  

  

  

"cache_variant": "string",

  

  

  

"content_type": "string",

  

  

  

"content_encoding": "string",

  

  

  

"origin_addr": "string",

  

  

  

"iprep_action": "string",

  

  

  

"waf_action": "string",

  

  

  

"waf_score": "string",

  

  

  

"waf_rule": "string",

  

  

  

"waf_rule_action": "string",

  

  

  

"waf_rule_score": "string",

  

  

  

"allowlist": "string",

  

  

  

"error_reason": "string",

  

  

  

"location": "string",

  

  

  

"device_type": "string",

  

  

  

"client_ip": "string",

  

  

  

"box": "string",

  

  

  

"env": "string",

  

  

  

"served_by": "string",

  

  

  

"geo_country": "string",

  

  

  

"geo_subdivisions": "string",

  

  

  

"geo_city": "string",

  

  

  

"geo_asn": "string",

  

  

  

"geo_asorg": "string",

  

  

  

"geo_iseu": "string",

  

  

  

"request_length_n": 0,

  

  

  

"status_code": 0,

  

  

  

"bytes_sent_n": 0,

  

  

  

"bytes_saved_n": 0,

  

  

  

"cache_ttl_n": 0,

  

  

  

"age_n": 0,

  

  

  

"iprep_score_n": 0,

  

  

  

"request_time_s": 0,

  

  

  

"core_connect_time_s": 0,

  

  

  

"core_time_s": 0,

  

  

  

"origin_connect_time_s": 0,

  

  

  

"origin_time_s": 0,

  

  

  

"geo_lat": 0,

  

  

  

"geo_lon": 0

  

  

}

  

]

}

GET

/api/organizations/{organizationId}/traffic-logs

Playground

Authorization

ApiToken

Variables

Key

Value

organizationId*

page

itemsPerPage

from

to

zoneId

order[event_time]

status_code

host

q

Samples

Powered by VitePress OpenAPI