Skip to main content
Client Query Access Logs
curl --request PUT \
  --url https://agents-api.kolena.com/api/v1/client/access-logs/query \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "time_range": {
    "start_time": "2023-11-07T05:31:56Z",
    "end_time": "2023-11-07T05:31:56Z"
  },
  "filters": {
    "users": [
      "<string>"
    ],
    "client_ips": [
      "<string>"
    ]
  },
  "page_size": 100,
  "cursor": "<string>"
}
'
{
  "total_events": 123,
  "events": [
    {
      "timestamp_millis": 123,
      "workspace_id": 123,
      "user": "<string>",
      "client_ip": "<string>",
      "operation": "<string>",
      "http_path": "<string>",
      "http_method": "<string>",
      "http_status": 123
    }
  ],
  "next_cursor": "<string>"
}
This is available on the Enterprise Plan. Contact Kolena if you’re not on an Enterprise plan but would like to try this feature.
Rate Limit: This endpoint is limited to requests per minute per user.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>. The <token> represents your API key, which must be acquired from the Kolena platform.

Body

application/json
​
time_range
ClientTimeRange · object
​
filters
LogFilters · object
​
page_size
integer
default:100
Required range: 1 <= x <= 10000
​
cursor
string | null

Response

Successful Response

​
total_events
integer
required

Total number of events matching the query filters

​
events
AccessLogEvent · object[]
required

List of access log events matching the query

​
next_cursor
string | null

Cursor to use for fetching the next page of results