Generate compliance report
Generate a comprehensive compliance report for a specified date range. The report aggregates audit log data into a compliance-focused summary suitable for regulatory reporting.
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
startDate | string | Yes | Report start date (ISO 8601) |
endDate | string | Yes | Report end date (ISO 8601) |
format | string | No | Output format: json (default) or csv |
Response Fields
Summary Section
| Field | Type | Description |
|---|---|---|
reportPeriod | object | Start and end dates of the report |
generatedAt | string | Report generation timestamp |
organizationId | UUID | Organization the report covers |
totalEvents | number | Total audit events in period |
totalTransactions | number | Total transactions in period |
totalUsers | number | Unique users with activity |
Transaction Summary
| Field | Type | Description |
|---|---|---|
totalVolume | object | Total transaction volume by asset |
transactionsByStatus | object | Transaction counts by status |
transactionsByType | object | Transaction counts by type |
approvalMetrics | object | Approval workflow statistics |
Security Events
| Field | Type | Description |
|---|---|---|
failedTransactions | array | List of failed transactions with reasons |
blockedByPolicy | array | Transactions blocked by policy |
suspiciousActivity | array | Flagged suspicious activities |
User Activity
| Field | Type | Description |
|---|---|---|
activeUsers | array | Users with activity in period |
userActionCounts | object | Action counts per user |
Use Cases
- Generate regulatory compliance reports
- Prepare for auditor reviews
- Create monthly/quarterly activity summaries
- Document transaction history for compliance
- Track policy enforcement effectiveness
Required Permission
audit:read
Generate compliance report
Generate a comprehensive compliance report for a specified date range. The report aggregates audit log data into a compliance-focused summary suitable for regulatory reporting.
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
startDate | string | Yes | Report start date (ISO 8601) |
endDate | string | Yes | Report end date (ISO 8601) |
format | string | No | Output format: json (default) or csv |
Response Fields
Summary Section
| Field | Type | Description |
|---|---|---|
reportPeriod | object | Start and end dates of the report |
generatedAt | string | Report generation timestamp |
organizationId | UUID | Organization the report covers |
totalEvents | number | Total audit events in period |
totalTransactions | number | Total transactions in period |
totalUsers | number | Unique users with activity |
Transaction Summary
| Field | Type | Description |
|---|---|---|
totalVolume | object | Total transaction volume by asset |
transactionsByStatus | object | Transaction counts by status |
transactionsByType | object | Transaction counts by type |
approvalMetrics | object | Approval workflow statistics |
Security Events
| Field | Type | Description |
|---|---|---|
failedTransactions | array | List of failed transactions with reasons |
blockedByPolicy | array | Transactions blocked by policy |
suspiciousActivity | array | Flagged suspicious activities |
User Activity
| Field | Type | Description |
|---|---|---|
activeUsers | array | Users with activity in period |
userActionCounts | object | Action counts per user |
Use Cases
- Generate regulatory compliance reports
- Prepare for auditor reviews
- Create monthly/quarterly activity summaries
- Document transaction history for compliance
- Track policy enforcement effectiveness
Required Permission
audit:read