Export Audit Records
POST https://{{axpAPIDomain}}/api/admin/group/v1/accounts/:accountId/audit-records:export?orderBy=date desc
This API requires the Account Administrator role.
Exports the audit records within the date-time range in CSV format.
A maximum of 1000 records can be exported for a given date-time range per request.
If the number of records within a date-time range exceeds the maximum then this API will return a HTTP 400 Bad Request. This response will contain: * A human readable message explaining the issue. * A unique error code that a client can use to identify the issue.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
orderBy | string | Field name on which sorting needs to be performed. The possible fields | |
| you ordered on are date (date of audit record) and author. | |||
| Field Names are case-sensitive (should be written as it is in description). The default sorting order is descending. To specify ascending order, a suffix " asc" should be added. For example, "date asc" for ascending or "date desc" for descending". | |||
Request Body
{"startDate"=>"2021-11-13T20:25:39.534Z", "endDate"=>"2021-11-15T16:07:12.723Z", "event"=>"CREATED", "author"=>"jsmith@example.com", "type"=>"GROUP", "ipAddress"=>"165.225.72.60", "searchKeyword"=>"Out-of-Office"}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
appkey | string | ||
Content-Type | string | ||
Accept | string |
RESPONSES
status: OK
"Account Id,Date,Event,Author,IP Address,Type,Audit Data\nABCDEF,2021-11-14T09:24:05.234Z,CREATED,jsmith@example.com,165.225.72.60,GROUP,\"{\"\"groupId\"\":\"\"rt3e4567-e89b-12d3-a456-556642440000\"\",\"\"description\"\":\"\"Credit Card Agent Group\"\",\"\"name\"\":\"\"CreditCardAgentGroup\"\",\"\"resources\"\":[\"\"type\"\":\"\"User\"\",\"\"resourceIds\"\":[\"\"04703a3a-3dfb-4606-ae79-fd0fe0be3e64\"\"]}\"\n"