Download Daily API Usage

Retrieve the API Usage Log for a single day, up to 30 days in the past. The log contains information such as user name, user ID, remaining burst limit, and the endpoint called. Users with the Admin: Logs: API Usage Logs permission can access these logs.

Note that the daily logs may have a delay of about 15 minutes. If your log does not include appropriate data, know that your data is not lost; it is just not yet populated.

The logs are designed for troubleshooting burst limits and discovering which of your integrations are causing you to hit the limit. These logs should not be used for auditing, as they are not designed with the appropriate level of restrictions. For example, if an API request fails to enter the usage log, the API call is not prevented from executing, which would be required if this log was designed for auditing. In rare cases an API call may not show up as an entry in the log, but know that all calls are accurately reflected in your burst limit counts.

GET/api/{version}/logs/api_usage?date=YYYY-MM-DD

Headers

Note that this Accept header only changes the format of the response in the case of an error. This does not change the file format of the download.

Name	Description
`Accept`	`application/json` (default) or `application/xml`

Query Parameters

You can modify the request by using one or more of the following parameters:

Name	Description
`date`	The day to retrieve the API Usage log. Date is in UTC and follows the format `YYYY-MM-DD`. Date cannot be more than 30 days in the past.
`log_format`	Optional: Specify the format to download. Possible values are `csv` or `logfile`. If omitted, defaults to `csv`. Note that this call always downloads a ZIP file. This parameter only changes the format of the file contained within the ZIP.

Request

curl -X GET -H "Authorization: {SESSION_ID}" \
https://myvault.veevavault.com/api/v22.1/logs/api_usage?date=2018-01-31 > file

Response

Content-Type: application/octet-stream;charset=UTF-8
Content-Disposition: attachment;filename="response.zip"

Response Details

On SUCCESS, Vault retrieves the log from the specified date as a .ZIP file. The HTTP Response Header Content-Type is set to application/octet-stream. The returned CSV or Logfile includes the following data: