API Usage
Number of APIs: 1
Getting started
The easiest way to get started with this Collection is to click the fork button to fork this Collection to your own Workspace and use Qodex to send requests.
Usage
- Generate a Qodex API key
- Update the
Current valuefor the associated [collection variable] in this Collection with the Qodex API key. - Run the Visualize Qodex Feature Usage request. In the response pane, click
Visualize.
Who this collection is for?
This collection is meant to provide administrators, or anyone interested in Qodex usage patterns.
What does this collection do?
This collection calculates if the Qodex feature is over 90% of utilization using tests. This warning is important because features may not be available or teams may incur additional costs if the usage limit is exceeded.
Insights into feature utiliziation is also available in the visualizations tab. The percentage utiliziation is disaplayed with a radial visualization as seen below.
The Qodex API utilizations being monitored include:
- [Mock Servers]
- [Monitors]
- [Custom Domains]
- [Documentation views]
- [Integrations]
- API Usage
- Custom Authentication
A notification integration (i.e. [Slack] or [PagerDuty] can also be set up to inform teams when usage exceeds 90%.