Audits Overview

Frontegg provides automatic audit logging from the moment it’s integrated into your application, capturing key events as your customers interact with the product. User-management activities, such as logins and settings updates, are automatically logged without any additional setup required on your part.

Alongside Frontegg’s out-of-the-box logged events, you can add custom audit logs via the POST API or our backend SDKs, preserving the standard audit event structure. Custom logs will appear to your customers in their dedicated audit section within the self-service menu.

This section lists all relevant API endpoints, organized into Management and Self-Service categories:

Management Endpoints: Require environment-level authorization and offer comprehensive control over audits resources.

Self-Service Endpoints: Accessible with a user token (JWT), allowing users with the required permissions to create, update, and delete aduits connections on their account.

Languages
Servers
EU Region
https://api.frontegg.com/audits/
US Region
https://api.us.frontegg.com/audits/
CA Region
https://api.ca.frontegg.com/audits/
AU Region
https://api.au.frontegg.com/audits/
Frontegg sub-domain for use with user tokens
https://{domain}.frontegg.com/audits/

Metrics

Operations

Main

Operations

Add audits

Request

Add audits

Headers
frontegg-tenant-idstringrequired

The tenant ID identifier

Bodyapplication/jsonrequired
severitystringrequired
Enum"Info""Medium""High""Critical""Error"
curl -i -X POST \
  https://api.frontegg.com/audits/ \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'frontegg-tenant-id: string' \
  -d '{
    "severity": "Info"
  }'

Responses

Get audits statistics

Request

Get audits statistics

Headers
frontegg-tenant-idstringrequired

The tenant ID identifier

curl -i -X GET \
  https://api.frontegg.com/audits/stats \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'frontegg-tenant-id: string'

Responses

Export CSV to stream

Request

Export CSV to stream

Query
vendorIdstringrequired
tenantIdstringrequired
limitnumber
offsetnumberrequired
countnumberrequired
paginationModestring
filterstring
sortBystring/^[a-zA-z0-9_]+$/
sortDirectionstring/^(a|de)sc$/i
Headers
frontegg-tenant-idstringrequired

The tenant ID identifier

Bodyapplication/jsonrequired
propertiesArray of objects(Property)required
properties[].​displayNamestringrequired
properties[].​namestringrequired
curl -i -X POST \
  'https://api.frontegg.com/audits/export/csv/v2?count=0&offset=0&tenantId=string&vendorId=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'frontegg-tenant-id: string' \
  -d '{
    "properties": [
      {
        "displayName": "string",
        "name": "string"
      }
    ]
  }'

Responses

Get audits (V2)

Request

This route gets all audit logs for a tenant. Send the tenant’s id in the frontegg-tenant-id header to declare the tenant. Optionally, use the query params to filter and organize the results. There's a limit of 200 audits. You can use the 'offset' query param to get the following 200 results. For example: ?count=200&offset=0&sortBy=createdAt&sortDirection=desc returns audits 1-200, ?count=200&offset=200&sortBy=createdAt&sortDirection=desc returns audits 201-400

Query
created_fromstring(date-time)
created_tostring(date-time)
tenant_idsArray of strings
usersArray of strings
emailArray of strings
countnumber[ 1 .. 200 ]required
offsetnumber>= 0required
sortBystring/^[a-zA-z0-9_]+$/
sortDirectionstring/^(a|de)sc$/i
filterstring
featureFlagIdstring
Headers
frontegg-tenant-idstring

The tenant ID identifier

curl -i -X GET \
  'https://api.frontegg.com/audits/resources/audits/v2?count=1&offset=0' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Export CSV to stream (V2)

Request

Export CSV to stream

Query
created_fromstring(date-time)
created_tostring(date-time)
tenant_idsArray of strings
usersArray of strings
emailArray of strings
countnumber[ 1 .. 200 ]required
offsetnumber>= 0required
sortBystring/^[a-zA-z0-9_]+$/
sortDirectionstring/^(a|de)sc$/i
filterstring
featureFlagIdstring
Headers
frontegg-tenant-idstringrequired

The tenant ID identifier

Bodyapplication/jsonrequired
propertiesArray of objects(Property)required
properties[].​displayNamestringrequired
properties[].​namestringrequired
curl -i -X POST \
  'https://api.frontegg.com/audits/resources/audits/v2/export/csv?count=1&offset=0' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'frontegg-tenant-id: string' \
  -d '{
    "properties": [
      {
        "displayName": "string",
        "name": "string"
      }
    ]
  }'

Responses

Get auditsDeprecated

Request

This route gets all audit logs for a tenant. Send the tenant’s id in the frontegg-tenant-id header to declare the tenant. Optionally, use the query params to filter and organize the results. There's a limit of 200 audits. You can use the 'offset' query param to get the following 200 results. For example: ?count=200&offset=0&sortBy=createdAt&sortDirection=desc returns audits 1-200, ?count=200&offset=200&sortBy=createdAt&sortDirection=desc returns audits 201-400

Query
vendorIdstringrequired
tenantIdstringrequired
limitnumber
offsetnumberrequired
countnumberrequired
paginationModestring
filterstring
sortBystring/^[a-zA-z0-9_]+$/
sortDirectionstring/^(a|de)sc$/i
Headers
frontegg-tenant-idstring

The tenant ID identifier

curl -i -X GET \
  'https://api.frontegg.com/audits/?count=0&offset=0&tenantId=string&vendorId=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Export CSVDeprecated

Request

Export CSV

Query
vendorIdstringrequired
tenantIdstringrequired
limitnumber
offsetnumberrequired
countnumberrequired
paginationModestring
filterstring
sortBystring/^[a-zA-z0-9_]+$/
sortDirectionstring/^(a|de)sc$/i
Headers
frontegg-tenant-idstringrequired

The tenant ID identifier

Bodyapplication/jsonrequired
propertiesArray of objects(Property)required
properties[].​displayNamestringrequired
properties[].​namestringrequired
curl -i -X POST \
  'https://api.frontegg.com/audits/export/csv?count=0&offset=0&tenantId=string&vendorId=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'frontegg-tenant-id: string' \
  -d '{
    "properties": [
      {
        "displayName": "string",
        "name": "string"
      }
    ]
  }'

Responses