Retrieves audit events using limit and offset pagination parameters to manage high-volume event extractions across sequential pages.
Paging metadata is provided in the response under meta.paging, reporting currentPageSize, totalSize, offSet, nextOffset, and nextUrl. The client can extract the nextUrl value directly to request the subsequent batch of records. The maximum value for limit is 10,000. If a request supplies a limit greater than 10,000, the API returns an HTTP 204 status with an error message indicating that the requested limit exceeds the specified limit.
Always inspect nextUrl or check if offSet + currentPageSize < totalSize to determine when all pages have been retrieved.
Method and endpoint
/audit/api/1/events
Parameters
| Parameter | Type | Required/optional | Description |
limit | Integer | Required | Number of records to return on the current page (1 to 10,000). |
offset | Integer | Required | Starting record index offset (zero-based). |
type | String | Optional | Event category filter: all (default), byok, or user_activity. |
Curl example
curl -X GET "https://audit.anaplan.com/audit/api/1/events?limit=50&offset=100" \
-H "Authorization: AnaplanAuthToken {anaplan_auth_token}" \
-H "Accept: application/json"
Response
Success response
If the request is successful, the API returns an HTTP 200 OK status code with meta paging controls and the requested slice of audit events.
| HTTP status | Status message | Description |
200 | OK | Page of audit records successfully retrieved. |
Example successful response body
{
"meta": {
"paging": {
"currentPageSize": 50,
"totalSize": 1250,
"offSet": 100,
"nextOffset": 150,
"nextUrl": "https://audit.anaplan.com/audit/api/1/events?limit=50&offset=150"
}
},
"response": [
{
"id": 971529164212789248,
"eventTypeId": "USR-04",
"userId": "8a80d86a5565443f01557f053e6719ba",
"tenantId": "8a80d8034e9a6fa0014e9aa747ae0002",
"message": "user logged in",
"success": true,
"eventDate": 1520433163000
}
]
}
Failure response
If the request is unsuccessful, the API returns an error code.
| HTTP status | Error message | Description/resolution |
204 | Requested limit exceeds maximum limit of 10000 | Reduce the limit query parameter to 10,000 or fewer. |
401 | Unauthorized | Invalid or expired authentication token. Re-authenticate with the Anaplan Authentication Service. |
Example error response body
{
"status": "FAILURE",
"statusMessage": "Requested limit exceeds maximum limit of 10000"
}