Retrieve Audit Details
GET https://{{vaultDNS}}/api/{{version}}/audittrail/:{audit_trail_type}
https://developer.veevavault.com/api/21.1/#retrieve-audit-details
Retrieve all audit details for a specific audit type. This request supports optional parameters to narrow the results to a specified date and time within the past 30 days.
To export a full audit trail with the same formatting as exports you initiate in the UI, set alldates to true, leave startdate and enddate blank, and set formatreasult to csv. When the job is complete, you will receive an email containing links to a zipped file for each year. You can export any audittrailtype. Use the Retrieve Audit Types API to retrieve types available in your vault. Note that you can only run a full audit export (all_dates = true) on each audit type once per day.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
start_date | null | Specify a start date to retrieve audit information. This date cannot be more than 30 days ago. Dates must be YYYY-MM-DDTHH:MM:SSZ format, for example, 7AM on January 15, 2016 would use 2016-01-15T07:00:00Z. If omitted, defaults to the last 30 days. | |
end_date | null | Specify an end date to retrieve audit information. This date cannot be more than 30 days ago. Dates must be YYYY-MM-DDTHH:MM:SSZ format, for example, 7AM on January 15, 2016 would use 2016-01-15T07:00:00Z. If omitted, defaults to the last 30 days. | |
all_dates | null | Set to true to request audit information for all dates. You must leave start_date and end_date blank when requesting an export of a full audit trail. | |
format_result | null | To request a downloadable CSV file of your audit details, use csv. The response contains a jobId to retrieve the job status, which contains a link to download the CSV file. If omitted, the API returns a JSON response and does not start a job. If all_dates is true, this parameter is required. | |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Authorization | string | ||
Accept | string |