Skip to main content
APIContext
Talk to salesStart free
Start HereGuidesConceptsCLIReferenceChangelog

Monitoring Coverage

Monitoring Coverage is a Conformance setting that tracks what percentage of your configured Monitors and unique server endpoints are actively being monitored by APImetrics. The higher the coverage percentage, the more complete your monitoring — ensuring issues are caught across your full API surface, not just a subset of it.

Coverage is computed against the API surface defined by the OpenAPI specification attached to the project. The specification establishes the expected set of endpoints, and coverage gating fails Conformance when the monitored portion falls below your thresholds. For how to upload, select, and maintain that specification, see Manage OpenAPI Specifications.

Monitor Coverage vs. Endpoint Coverage​

APImetrics distinguishes between two types of coverage:

  • Monitor Coverage refers to the percentage of Monitors configured in your project that are currently being monitored.
  • Endpoint Coverage refers to the percentage of unique server endpoints — defined by their method, host, and path that are being monitored. Since a single endpoint can be called from multiple Monitors within a project, endpoint coverage gives you a distinct view of how much of your actual API surface area is covered.

Enabling Monitoring Coverage Checks​

To configure Monitoring Coverage for a project:

  1. From the left-hand navigation, select Conformance.
  2. Go to the Settings tab.
  3. Scroll down to the Manage Monitoring Coverage section.
  4. Toggle Enable Coverage Checks to ON.
  5. Enter your desired threshold percentages for Monitor Coverage and Endpoint Coverage.
  6. Click Save.
Conformance-Monitoring_Coverage

Setting Your Coverage Thresholds​

If all endpoints in your project are being monitored, set both Monitor Coverage and Endpoint Coverage to 100%. Otherwise, enter the values that reflect your project's monitoring configuration.

Not Sure of Your Coverage Percentages?​

If you're unsure what percentage of your Monitors or endpoints are currently being monitored, the recommended approach is:

  1. Leave both Monitor Coverage and Endpoint Coverage at 100% (the default values).
  2. Run a Conformance check using the Evaluate Most Recent Calls button on the Conformance Summary page.
  3. The check will likely return a fail — but the Issue Details tab will display the actual current coverage percentages for your project.
  4. Return to Conformance > Settings > Manage Monitoring Coverage and update the Monitor Coverage and Endpoint Coverage fields with those values.
  5. Click Save.

This approach lets APImetrics surface the real coverage data from your project, so you can set accurate and meaningful thresholds.