Audit Log Reports

Audit log reports provide a complete history of all operations performed in your Volt account. Use them for compliance, security audits, and tracking user activity.

What's included

Audit logs capture:

User login/logout events
Configuration changes
Account modifications
Permission changes
Application settings updates

Request an audit log report

POST /reports/auditlog
Content-Type: application/json
Authorization: Bearer YOUR_ACCESS_TOKEN

{
  "startDate": "2024-01-01T00:00:00Z",
  "endDate": "2024-01-31T23:59:59Z"
}

With customer filter

POST /reports/auditlog
Content-Type: application/json
Authorization: Bearer YOUR_ACCESS_TOKEN

{
  "startDate": "2024-01-01T00:00:00Z",
  "endDate": "2024-01-31T23:59:59Z",
  "customerId": "550e8400-e29b-41d4-a716-446655440000"
}

Without customerId, the report includes audit logs for the entire customer hierarchy.

Report fields

Field	Description	Example
`id`	Unique identifier for the record	39b3711a-f3cc-40d4-bb32-c194e8548565
`customerId`	Volt customer ID (UUID)	497f6eca-6276-4993-bfeb-53cbbbba6f08
`customerName`	Volt customer name	Merchant ABC
`createdAt`	Timestamp when the record was created	2024-10-15 06:08:00.365 +0000 UTC
`eventAction`	Action performed during the event	loggedIn
`context`	Additional context or metadata about the event	common
`domainModel`	The domain model associated with the event	user
`recordId`	Unique identifier for the domain record, in this example user ID	36b8f84d-df4e-4d49-b662-bcde71a8764f
`correlationId`	Correlation ID used for tracing the request	ce0ebca3-a16a-4488-a94c-1d79bedddea6
`userId`	Unique identifier (UUID) for the Volt user	36b8f84d-df4e-4d49-b662-bcde71a8764f
`userName`	Name of the Volt user	John Doe
`userEmail`	Email address of the Volt user	johndoe@example.com

Example CSV

id;customerId;customerName;createdAt;eventAction;context;domainModel;recordId;correlationId;userId;userName;userEmail
4a4900d5-0952-4f3d-aa88-7f961cbcaae5;9c6ee76c-d383-434d-957f-3e8d62892c48;Example customer;2025-01-15 06:08:00.365 +0000 UTC;loggedIn;common;user;2ad14d93-5972-49fd-b635-102c79647460;ce0ebca3-a16a-4488-a94c-1d79bedddea6;2ad14d93-5972-49fd-b635-102c79647460;John Doe;johndoe@example.com

Use cases

Security audits - Track who did what and when
Compliance - Maintain required audit trails (GDPR, PCI-DSS)
Troubleshooting - Investigate issues with correlation IDs
User activity monitoring - Review team member actions
Change management - Track configuration changes
Fraud detection - Identify suspicious activity patterns

Use the correlationId field to trace related events across the system. This is especially useful when working with Volt support to investigate issues.