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.
What is covered
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.
Select a category
You choose which category to retrieve with the type parameter, which behaves identically on the GET /events and POST /events/search endpoints.
type value | Returns |
all | Every tracked event |
byok | BYOK (Bring Your Own Key) encryption events only |
user_activity | User account and session events only |
BYOK events
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.
| Event | What it records | Event code |
| Add guardpoint | The workspace named in Object ID was encrypted | DSM-229 |
| Add user to domain | A user was added to a domain while being assigned the Encryption Admin role | DSM-405 |
| Create symmetric key | An Encryption Administrator created an encryption key | DSM-239 |
| Delete pending guardpoint | A workspace is about to be decrypted | DSM-502 |
| Marked guardpoint pending delete | A workspace was decrypted | DSM-501 |
| Switch domain | An action required a change of domain, such as a login or an Encryption Admin role assignment | DSM-426 |
| Update key | An Encryption Admin changed an encryption key's expiry date | DSM-576 |
| User logged in | A user logged in; User ID identifies who | DSM-267 |
User activity events
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.
| Action | Success event | Success code | Failure event | Failure code |
| Log in | User log in success | USR-8 | User log in failure | USR-9 |
| Log out | User log out success | USR-10 | User log out failure | USR-11 |
| User created | User created | USR-1 | Not tracked | — |
| User updated | User updated | USR-5 | Not tracked | — |
| Access model | User access model success | USR-13 | User access model failure | USR-14 |
| Enable user | User enabled | USR-3 | Not tracked | — |
| Disable user | User disabled | USR-4 | Not tracked | — |
| Assign to tenant | User assigned to tenant success | USR-15 | User assigned to tenant failure | USR-16 |
| Remove from tenant | User removed from tenant success | USR-17 | User removed from tenant failure | USR-18 |
Anatomy of an event record
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.
| Field | Meaning | Present in |
id | Unique event ID | All events |
eventTypeId | Event code, such as DSM-DAO0267I or USR-1 | All events |
message | Event name, such as "user logged in" | All events |
userId | User who performed the action | All events |
tenantId | Tenant the event belongs to | All events |
objectTenantId | Tenant of the affected object | All events |
objectId | Affected object, such as a user or a workspace | User activity only |
objectTypeId | Type of the affected object | User activity only |
success | Whether the action succeeded (true or false) | User activity only |
errorNumber | Error code on failure | User activity only |
ipAddress | Client IP address | User activity only |
userAgent | Client browser or agent string | User activity only |
sessionId | Session identifier | User activity only |
hostName | Anaplan host that logged the event | All events |
serviceVersion | Version of the service that logged it | All events |
eventDate / eventTimeZone | When the event happened | All events |
createdDate / createdTimeZone | When the event was stored | All events |
checksum | SHA-256-length hash for integrity checks | All events |