APImetrics

The APImetrics Developer Hub

Welcome to the APImetrics developer hub. You'll find comprehensive guides and documentation to help you start working with APImetrics as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    

Call Conditions / Assertions

Setting assertions on an API basis

Key Concepts

Setting Assertions/Conditions in an API call

The main way to handle assertions/conditions is via the 'Conditions' tab in the API call editor. You can also set timing based conditions in the SLA Management option.

APImetrics reviews results returned by an API call in a specific sequence.

  • HTTP Status Code
  • Response Body Size
  • Header Content
  • Body Content
  • API Call Timing

Default Settings

By default a HTTP 2XX code is a pass and a 5XX code is a fail, however, from the conditions tab in the API editor you can change those and parse results or set specific timing based rules.

Default Pass HTTP 200

By default, a pass is any code returned with a 2XX result.

Default failure HTTP 500

By default, any 5XX code is deemed a failure

Default warning HTTP 4XX

Typically a warning is due to an authentication error with the API call, and warnings are not usually handled in the statistics which focus on pass and fail.

Result Events

When a condition is met, there are 4 possible outcomes - do nothing, the result is a pass, a fail, or a warning is generated. Alerts can then be keyed to work off the triggered event.

Different handling events and triggers can be set for a True or False result.

Call Conditions / Assertions

Setting assertions on an API basis