The API Usage page provides an overview of OASIS API usage, including call volume, errors, and activity by user and endpoint. You can also use this page to create, review, and manage bearer tokens.
Requirements:
- User must have Admin access to Software.
| Note: API activity is currently limited to eight concurrent calls across all users and 100,000 calls per user per day. |
1. Navigate to the Configuration page.
2. Click Online Activity, then select Online API Usage.
3. The API Usage page will appear.
Viewing API Usage
The Dashboard tab provides an overview of API usage to help you track activity, identify errors, and understand how the API is used across users and endpoints.
Daily Summary
This section displays current API usage and limits.
- Active Calls: The number of API calls currently in progress compared to the concurrent call limit.
- Total Calls: The total number of API calls made today.
- Errors: The percentage of today's API calls that resulted in an error.
Click Total Call and Errors to view more details.
Usage Reports
This section provides reports to show API activity over time.
Use the Filters section to control the information displayed throughout the usage reports.
- Timeframe: Select the period of API activity to review.
- Endpoint: Select a specific API endpoint or view activity for all endpoints.
- User: Select a specific user or view activity for all users.
Calls Over Time
This graph displays API activity during the selected timeframe. Use this graph to identify changes in API activity or periods with increased errors.
Click a data point to view more details.
Top 5 Endpoints
This table identifies the endpoints with the most API activity during the selected timeframe.
Click an endpoint to view individual calls.
Error Log
This table displays individual API errors recorded during the selected timeframe. Use this information to identify which token, user, and endpoint were associated with an unsuccessful request.
Click an error to view more details.
Managing Bearer Tokens
The Tokens tab lists all bearer tokens created within OASIS. The summary at the top of the page displays the number of Active Tokens and Active Users (those with active tokens).
Use the tabs to display All, Active, Expired, or Terminated tokens. You can also search for a token by token name or user.
Creating a Bearer Token
Click + Create Token to create a bearer token for yourself or another user.
| Note: Users can also create and view their bearer tokens from Security Settings. |
Viewing a Bearer Token
1. Select a bearer token to view its details.
2. Click Edit or Terminate Token to manage its details and access.
- Edit: Change the token's name and expiration date.
- Terminate Token: Revoke the token's access and prevent it from being used.
Comments
0 commentsPlease sign in to leave a comment.