Skip to main content

Get Audit Log Type Definitions API

Introduction

Retrieves the audit log scopes and event type definitions supported by the current organization.

Before querying audit log details, you can call this API first to obtain the log scope (domain) and event names (event_types), and then call the Get Audit Log Details API to query logs by scope.

The supported log scopes are listed below.

Log Scope (domain)

Description

Available Filter Fields

login

User login logs.

filters.actor_ids

platform

Management logs for the organization, contacts, API configuration, plugins, and Open Platform.

filters.actor_ids

app_builder

App building logs for apps, forms, dashboards, aggregate tables, Smart Assistants, Data Factories, and more.

filters.actor_ids
filters.app_ids
filters.entry_ids
filters.types

kms

Knowledge base management logs.

filters.actor_ids

Note: For specific event names under each log scope (domain), see: Audit Event List.


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

This API only retrieves audit log type definitions that can be queried by the organization to which the current API Key belongs.

Rate Limit: 30 requests/second

Method: POST

Request Parameters:

Parameter

Required

Type

Description

Pass an empty object {} in the request body.

Response Parameters

Parameter

Type

Description

domains

String

The list of audit log scopes.

domains[].domain

String

The scope identifier. Pass this value as domain when querying details.

domains[].event_types

String

The list of event types supported by the current scope. Pass this value as event_types when querying details.

Response Example

{

"domains": [

{

"domain": "login",

"event_types": [

"auth.session.login"

]

},

{

"domain": "app_builder",

"event_types": [

"admin.app.create",

"admin.app.watermark_enable"

]

}

]

}

Did this answer your question?