Retrieve Email Notification Histories
GET https://{{vaultDNS}}/api/{{version}}/notifications/histories
https://developer.veevavault.com/api/23.1/#Retrieve_Email_Notification_History
Retrieve details about the email notifications sent by Vault. Details include the notification date, recipient, subject, and delivery status. In the UI, this information is available in Admin > Operations > Email Notification Status. Learn more about Email Notification Status in Vault Help.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
start_date | string | Specify a start date to retrieve notification history. This date cannot be more than 2 years ago. Dates must be in YYYY-MM-DD or YYYY-MM-DDTHH:mm:ssZ format. If time is omitted (THH:mm:ssZ), defaults to the start of the day. If start_date is omitted entirely, defaults to the start of the previous day. | |
| If you’ve specified a start_date, you must also specify an end_date. | |||
end_date | string | Specify an end date to retrieve notification history. This date cannot be more than 30 days away from the specified start_date. Dates must be in YYYY-MM-DD or YYYY-MM-DDTHH:mm:ssZ format. If time is omitted (THH:mm:ssZ), defaults to the time of the API request. | |
| If you’ve specified an end_date, you must also specify a start_date. | |||
all_dates | boolean | Set to true to request notification history for all dates. This is the same as requesting a full CSV export from the Vault UI. When requesting a full notification history, you must leave start_date and end_date blank and set format_result to csv. You can request an export of notification history for all_dates once every 24 hours. | |
format_result | string | To request a downloadable CSV file of your notification history, set this parameter to csv. The response contains a jobId to retrieve the job status, which provides a link to download the CSV file. If omitted, the API returns a JSON response with notification history and does not start a job. If all_dates is true, this parameter must be csv. | |
limit | null | Paginate the results by specifying the maximum number of histories per page in the response. This can be any value between 1 and 1000. If omitted, defaults to 200. | |
offset | null | Paginate the results displayed per page by specifying the amount of offset from the entry returned. If omitted, defaults to 0. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Authorization | string | ||
Accept | string |