Export Audit Records
POST https://{{axpAPIDomain}}/api/admin/match/v1/accounts/:accountId/audit-records:export?orderBy=date desc
This API requires the Account Administrator role.
Exports the audit records within a start date and end date 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-senstive (should be written as it is in description). The default sorting order is ascending. To specify descending order, a suffix " desc" should be added. For example, "date" 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"=>"QUEUE", "ipAddress"=>"165.225.72.60", "searchKeyword"=>"Support"}
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\n{{accountId}},2021-11-14T09:24:05.234Z,CREATED,jsmith@example.com,165.225.72.60,QUEUE,\"{\"\"queueId\"\":\"\"d62d5178-9920-415a-a5d9-066716384750\"\",\"\"name\"\":\"\"NA Support\"\",\"\"description\"\":\"\"Route enagements to support agents in the NA Region\"\",\"\"timetableId\"\":\"\"7893b4a3-c952-43f5-87c7-8cefa1f49685\"\",\"\"defaultAccountQueue\"\":false,\"\"afterContactWork\"\":true}\"\n"