Introduction
Queries audit log details for the current organization by scope.
Plan Description
This is a paid advanced feature. For details, contact our Sales Team.
API Version
API Version | Updated On | Description |
v1 | 2026-05-28 | Initial release |
API Call
Rate Limit: 30 requests/second
Method: POST
Request Parameters:
Parameter | Type | Required | Description |
| String | Yes | The log scope. |
| String | Yes | The query start time in UTC. Format example: |
| String | Yes | The query end time in UTC. Format example: |
| String[] | No | The list of event types. If omitted, all event types supported by the current log scope, namely |
| Number | No | The number of records returned per request. Default: |
| String | No | The pagination cursor. Omit this parameter for the first query. To query the next page, use the |
| Object | No | Filter conditions. |
Notes:
The span of time_range must not exceed 31 days.
Each request can query only one log scope, namely one domain.
If a filters field that is not supported by the current log scope, namely domain, is passed, a parameter error will be returned.
Pagination is sorted by event time in descending order.
Request Example
{
"domain": "api",
"time_range": {
"start": "2026-04-01T00:00:00.000Z",
"end": "2026-04-13T23:59:59.000Z"
},
"event_types": [
"api.request.invoke_failed"
],
"filters": {
"outcomes": [
"failure"
],
"endpoints": [
"/api/v5/app/list"
]
},
"limit": 100
}
Response Parameters
Parameter | Description |
| Indicates whether more pages are available. |
| The cursor for the next page. Returned when |
| The list of audit logs. |
| The event ID in the format |
| The event occurrence time as a UTC time string. |
| The standard event type. |
| The audit log scope. |
| Organization information. |
| Information about the actor. |
| Event information. |
| Information about the operated resource. |
| Scenario context. |
| Event details. |
Response Example
{
"has_more": true,
"cursor": "MTc3NjE1OTAwMDAwMCw2NjExMjIzMzQ0NTU2Njc3ODg5OWFhYmI=",
"items": [
{
"event_id": "api_request_logs:66112233445566778899aabb",
"event_time": "2026-04-13T09:30:00.000Z",
"event_type": "api.request.invoke_failed",
"domain": "api",
"tenant": {
"id": "58744c7322577d7b5ee6c8f5"
},
"actor": {
"type": "member",
"id": "58744c7322577d7b5ee6c8f5",
"ip": "203.0.113.10",
"user_agent": "Mozilla/5.0"
},
"event": {
"category": "api",
"action": "invoke",
"outcome": "failure",
"severity": "medium"
},
"resource": {
"type": "api",
"id": "/api/v5/app/list",
"name": "/api/v5/app/list"
},
"context": {
"endpoint": "/api/v5/app/list"
},
"detail": {
"err_code": 17017
}
}
]
}
Filter Conditions
Log Scope ( | Supported Filter Fields | Description |
|
| Filters by actor member ID. |
|
| Filters by actor member ID. |
|
| Filters by actor member ID, app ID, form/dashboard ID, or operation object. |
|
| Filters by actor member ID. |
Filter Field Descriptions
Parameter | Type | Description |
| String[] | The list of actor member IDs. |
| String[] | The list of app IDs. Supported only when the log scope is app management. |
| String[] | The list of form, dashboard, and other entry IDs. Supported only when the log scope is app management, namely |
| String[] | The underlying raw log types. Supported only when the log scope is app management. In general, it is recommended to use the |
| String[] | The list of API Key names. Supported only when the log scope is |
| String[] | The list of API endpoints. Supported only when the log scope is |
| String[] | API response status. Supported values: |