API Usage

The API Usage Advanced tool allows users to view the API requests they’ve made, grouped by client, PAT, user, and more. This tool allows users to better monitor their API events.

To view this page, you must be an Account Admin.

To navigate to this tool, click Main Menu > Advanced and select API Usage from the left side menu.

API Usage

The tool includes a graph that displays the API requests over the timeframe, and underneath, a table of the API events. By default, the graph and table include API events from the last 24 hours, grouped by “Client Kind.”

The table does not list every API request separately. Rather, the timeframe is broken down into smaller times—for example, the 24 hours timeframe is broken down by hour—and a “Count” column indicates how many requests were made in that time.

Note: API requests are synced in batches of 25, so the may be a small delay between an API request and its appearance in the usage tool. 

Filter and Group

To change the timeframe, click the Timeframe filter dropdown and select the desired timeframe. You can view up to 90 days of API events. 

To change the way that the events are grouped, or organized, click on the dropdown in the top left corner.

Your events can be grouped by the following: 

• Client Kind: grouped by the type of client
• Client: grouped by the client application
• User: grouped by Fileviner user
• Person Access Token: grouped by the PAT, which can be generated in the Account Manager
• Rate Limit Bucket: grouped by rate limit bucket. Click Learn About Rate Limits at the top of the usage tool to learn more about these buckets.
• Method + URI: includes both the method and the request URI in the table

Sort and Export

Click on any column in the table  to sort by that column. An arrow appears in the column header to indicate the sorting direction. Click on the column header again to reverse sort, and again to stop sorting by that column. 

To export the table data as a .csv file or an excel file, right-click in the table and select Export. 

Read more about managing the table.