Audits module
/
Main
/
Get audits statistics

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.

Download OpenAPI description
Users, Auth and Security
Single Sign-On
SCIM Provisioning
Entitlements
Entitlements Agent
Accounts (Tenants)
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

Create a new audit entry in your account (tenant) audit trail. This endpoint allows you to log custom audit events with specified severity levels for security monitoring and compliance tracking.

Headers
frontegg-tenant-idstringrequired

The account (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

Retrieve comprehensive statistics and metrics about audit events for your account (tenant). This endpoint provides aggregated data to help you monitor audit activity, analyze security trends, and generate compliance reports.

Headers
frontegg-tenant-idstringrequired

The account (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 audit data as a CSV file stream with customizable columns and filtering options. This endpoint allows you to generate downloadable CSV reports of your audit trail data for compliance, analysis, or backup purposes.

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

The account (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