📄️ Create API Monitor
API monitors execute configured HTTP requests at regular intervals and trigger alerts based on configured assertion failures or via scripted assertion failures.
📄️ Edit an API Monitor
A previously configured API Monitor can be edited from Edit Monitor page.
📄️ Running a Monitor
Monitors can be executed manually or can be scheduled to run automatically at predefined intervals.
📄️ API Monitoring Results
API Monitor Results page shows the historical monitoring results for the monitor.
📄️ Using Environment Variables
API Monitors can leverage variables defined in Environments instead of hardcoding values in your test. Any variables defined in the associated environment can be accessed in Before Request, After Request scripts. Variables defined as MustacheJS templates in Request URL, headers, body can also be resolved.
📄️ Context variables
Context variables are available and be mutated during API monitor execution. Context variables stays available during the entire execution period.
📄️ Monitoring Assertions
Assertions are required to validate if your API is working as expected. Without any assertions, your API monitor will not report any failures. Assertions can be setup with simple configuration or even complex assertions can be also be scripted in After Request scripts.
📄️ Execution sequence
API monitors are capable of evaluating multiple expressions and executing custom scripts when a monitor is triggered for execution. Following is the flow of execution for a monitor.
📄️ Third party libraries
Our API monitoring environment comes packaged with the following third party libraries that can be readily used in your tests.
📄️ Preserving state values
We recommend that the monitors not have dependencies on any state values. However, there can be scenarios where a test may have dependency on a value previously created in another monitor.
📄️ Available APIs
Following DevRaven APIs are available for use in your scripts during execution of API monitoring checks.