Before you can alert on an event, you have to know that the platform records it. 

The Anaplan Audit API captures a specific scope of tenant activity. The Audit API tracks two categories of events, the individual events in each, the fields every record carries, and the gaps you need to close with live data or with Anaplan directly.

This API covers two categories of activity: eight Bring Your Own Key (BYOK) encryption events and fourteen user activity events.

Several boundaries shape that coverage. The API returns events only for the tenant your user belongs to, and it holds no more than 30 days of history. The Audit functionality in Anaplan is meant as a delivery mechanism rather than an archive, which means longer term retention is your responsibility. Retrieve logs often and store them in your own systems.

Note that access is limited to users with the Tenant Auditor role, and Anaplan Audit must be enabled on the tenant before any events are returned.

One further detail matters when you query by date. The from and to filters match the moment an event occurred (eventDate), not the moment Anaplan stored it (createdDate). The two can differ, so a late-arriving event can land inside a window you have already collected.

You choose which category to retrieve with the type parameter, which behaves identically on the GET /events and POST /events/search endpoints.

type valueReturns
allEvery tracked event
byokBYOK (Bring Your Own Key) encryption events only
user_activityUser account and session events only

The first category concerns encryption. With BYOK, a tenant manages its own keys, and the API records each step of that lifecycle: creating and renewing keys, encrypting a workspace, and later decrypting it. Anaplan calls an encrypted workspace a guardpoint, a term that recurs in several event names.

EventWhat it recordsEvent code
Add guardpointThe workspace named in Object ID was encryptedDSM-229
Add user to domainA user was added to a domain while being assigned the Encryption Admin roleDSM-405
Create symmetric keyAn Encryption Administrator created an encryption keyDSM-239
Delete pending guardpointA workspace is about to be decryptedDSM-502
Marked guardpoint pending deleteA workspace was decryptedDSM-501
Switch domainAn action required a change of domain, such as a login or an Encryption Admin role assignmentDSM-426
Update keyAn Encryption Admin changed an encryption key's expiry dateDSM-576
User logged inA user logged in; User ID identifies whoDSM-267

The second category tracks people rather than keys. Its fourteen events span nine actions, from logging in to being removed from a tenant. Five of those actions (logging in, logging out, accessing a model, and being assigned to or removed from a tenant) produce separate success and failure events. The other four (user created, updated, enabled and disabled) are single events with no failure counterpart.

User activity records are also richer than their BYOK counterparts. They carry a success flag, the client's ipAddress and its userAgent, the fields a SIEM most often needs to correlate suspicious behaviour.

ActionSuccess eventSuccess codeFailure eventFailure code
Log inUser log in successUSR-8User log in failureUSR-9
Log outUser log out successUSR-10User log out failureUSR-11
User createdUser createdUSR-1Not tracked—
User updatedUser updatedUSR-5Not tracked—
Access modelUser access model successUSR-13User access model failureUSR-14
Enable userUser enabledUSR-3Not tracked—
Disable userUser disabledUSR-4Not tracked—
Assign to tenantUser assigned to tenant successUSR-15User assigned to tenant failureUSR-16
Remove from tenantUser removed from tenant successUSR-17User removed from tenant failureUSR-18

Whichever category an event belongs to, it arrives as a record with a common set of attributes. You can receive those records as JSON, the default, or as CEF (Common Event Format) by sending Accept: text/plain. CEF presents the same attributes as key=value pairs after the event type ID and message, which most SIEM products ingest natively. All timestamps are epoch milliseconds in UTC.

FieldMeaningPresent in
idUnique event IDAll events
eventTypeIdEvent code, such as DSM-DAO0267I or USR-1All events
messageEvent name, such as "user logged in"All events
userIdUser who performed the actionAll events
tenantIdTenant the event belongs toAll events
objectTenantIdTenant of the affected objectAll events
objectIdAffected object, such as a user or a workspaceUser activity only
objectTypeIdType of the affected objectUser activity only 
successWhether the action succeeded (true or false)User activity only
errorNumberError code on failureUser activity only
ipAddressClient IP addressUser activity only
userAgentClient browser or agent stringUser activity only
sessionIdSession identifierUser activity only
hostNameAnaplan host that logged the eventAll events
serviceVersionVersion of the service that logged itAll events
eventDate / eventTimeZoneWhen the event happenedAll events
createdDate / createdTimeZoneWhen the event was storedAll events
checksumSHA-256-length hash for integrity checksAll events