**Source URL:** https://limited.veevavault.dev/commercial/vault-toolbox/intellij-plugin/guides/developer-logs/api-usage-logs

# API Usage Logs

The API Usage log contains information such as which Vault API endpoints were called, the user name of the person who sent the request, and remaining burst limits. The API Usage log can help you troubleshoot burst limits and discover which of your integrations are causing you to hit the limit.

<Aside>
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.
</Aside>

You can use the Vault Toolbox plugin to retrieve the API Usage log for a single day, up to 30 days in the past, as well as analyze the log itself. Your user account must have the appropriate permissions to access the API Usage log.

## Downloading API Usage Logs

To download API Usage logs:

<Steps>
1.  Within IntelliJ IDEA, open the Vault Toolbox plugin from the righthand sidebar.
2.  Select the **Actions** (<Icon name="ph:sliders-horizontal" />) tab.
3.  Expand **Developer Logs** (<Icon name="ph:brackets-curly" />) and double-click **API Usage** (<Icon name="ph:globe" />).
    
    <ThemeImage srcLight="/images/toolbox/intellij-plugin/api_usage_log_light.png" srcDark="/images/toolbox/intellij-plugin/api_usage_log_dark.png" alt="IntelliJ Plugin API Usage Log" />
    
4.  In the dialog, select the checkbox for the dates you wish to download or click **Select** in the header to select all dates.
    
    <ThemeImage srcLight="/images/toolbox/intellij-plugin/api_usage_log_download_light.png" srcDark="/images/toolbox/intellij-plugin/api_usage_log_download_dark.png" alt="IntelliJ Plugin Download API Usage Log" />
    
5.  Optional: Click <Icon name="ph:arrows-counter-clockwise" /> to refresh the list.
6.  Click <Icon name="ph:download-simple" /> or **OK** to download the selected logs.
7.  Optional: After the logs have downloaded successfully, click <Icon name="ph:eye" /> within the dialog to open the log in a File Viewer or <Icon name="ph:crosshair-simple" /> to locate the folder within your project directory.
</Steps>

 

<ThemeImage srcLight="/images/toolbox/intellij-plugin/download_analyze_api_usage_log_light.png" srcDark="/images/toolbox/intellij-plugin/download_analyze_api_usage_log_dark.png" alt="Downloaded API Usage Log" />

Vault Toolbox generates the API Usage logs for the specified time period. Once the operation is complete, you can access the folders containing the downloaded API Usage logs from `toolbox/logs/api/{vaultid}` within your project directory. The CSV file prepended with the Vault ID summarizes all API Usage log data for the date indicated. After a log has been downloaded, you can analyze it.

## Importing API Usage Logs

You can also load an existing API Usage log into the workspace without re-downloading it from Vault. This is useful when you have an archive from a previous Vault Toolbox download, an export from Vault, or a file shared by a colleague.

To import API Usage logs:

<Steps>
1.  Within IntelliJ IDEA, open the Vault Toolbox plugin from the righthand sidebar.
2.  Select the **Actions** (<Icon name="ph:sliders-horizontal" />) tab.
3.  Expand **Developer Logs** (<Icon name="ph:brackets-curly" />) and double-click **API Usage** (<Icon name="ph:globe" />).
4.  In the dialog toolbar, click <Icon name="ph:upload-simple" /> to open the file chooser.
5.  Select a Vault log archive (`.zip`) or a single log file (`.csv`, `.log`, or `.txt`). Each file in the archive must include a date in `YYYY-MM-DD` format in its name, which Vault Toolbox uses to organize the imported files.
6.  In the *Import Log Archive* dialog, confirm or update the **Vault ID**. The plugin auto-fills this field from any leading digits in the file name. Review the preview table to see the destination for each file and whether it will be created as a **New** file or **Overwrite** an existing file.
7.  Click **OK** to import.
</Steps>

Once the operation is complete, the imported logs are available under `toolbox/logs/api/{vaultid}/{date}` and the table refreshes so you can analyze them.

## Analyzing API Usage Logs

You can use the Vault Toolbox plugin to analyze API Usage logs after they have been downloaded. The resulting CSV file contains information about each API call made on the indicated date, such as the endpoint name, response status, and error messages.

To analyze API Usage logs:

<Steps>
1.  Within IntelliJ IDEA, open the Vault Toolbox plugin from the righthand sidebar.
2.  Select the **Actions** (<Icon name="ph:sliders-horizontal" />) tab.
3.  Expand **Developer Logs** (<Icon name="ph:brackets-curly" />) and double-click **API Usage** (<Icon name="ph:globe" />).
4.  In the dialog, previously downloaded logs are differentiated by a <Icon name="ph:eye" /> within the *View* column. To proceed with analyzing the log(s), select the checkbox for one or more downloaded logs, then click <Icon name="ph:lightbulb" />. The CSV file of the analysis will then open in your preferred spreadsheet application.
5.  Optional: To clear local files from your project directory, select the checkbox for one or more downloaded logs, then click <Icon name="ph:x" />.
</Steps>

Once the operation is complete, you can access the analysis files for the API Usage logs from `toolbox/logs/api/{vaultid}/analysis` in your project directory. The CSV file appended with the date contains an analysis of all API Usage log data for that respective date.

---

**Previous:** [Working with Developer Logs](/commercial/vault-toolbox/intellij-plugin/guides/developer-logs)  
**Next:** [SDK Debug Logs](/commercial/vault-toolbox/intellij-plugin/guides/developer-logs/sdk-debug-logs)