audit_trail

This action downloads the audit trail. If the start_date parameter is provided, then it overrides the savepoint and starts at that date.
Otherwise it uses a savepoint. Each audit service has its own savepoint, called 'audit.Telephony', 'audit.TaskManagement', etc.
The savepoint parameter can be used to specify a different savepoint prefix.
Genesys only retains the most recent 365 days of audit data, so older start dates are clamped to the oldest available date.

The services parameter can be used to filter which services to download. If not provided, all services are downloaded. This is a string containing a list of services separated by commas.

Genesys defines the following audit services:

  • Telephony
  • TaskManagement
  • WebDeployments
  • AnalyticsReporting
  • Outbound
  • AgentConfig
  • Supportability
  • LanguageUnderstanding
  • ContentManagement
  • PeoplePermissions
  • Presence
  • SCIM
  • Architect
  • ContactCenter
  • Quality
  • SpeechAndTextAnalytics
  • PredictiveEngagement
  • Knowledge
  • Coaching
  • Learning
  • EmployeeEngagement
  • WorkforceManagement
  • Limits
  • Routing
  • Triggers
  • ProcessAutomation
  • NerService
  • ResponseManagement
  • Gamification
  • Callback
  • EmployeePerformance
  • NumberPurchasing
  • Groups
  • Emails
  • Integrations
  • Onboarding
  • Datatables
  • Directory
  • Webhooks
  • Marketplace
  • Messaging
  • Scripter
  • ExternalContacts
  • SocialListening
  • LogCapture
  • Billing
  • GDPR
  • JourneyAnalytics

Parameters

Parameter Description
start_date Optional Override the savepoint start date. Dates older than 365 days are clamped to the oldest available audit date.
services Optional Comma-separated list of services to extract audit trail from. Leave blank for all.
savepoint Optional The savepoint name prefix to use for the audit trail (default is 'audit'). This will use savepoints called '

Tables Affected

Variables Set

No variables set.

Permissions needed

  • audits:audit:view

Examples

  • audit_trail
  • audit_trail( start_date='2024-01-01', services='Telephony,TaskManagement' )
  • audit_trail( services='Directory' )