> For the complete documentation index, see [llms.txt](https://developer.harness.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.harness.io/web-application-and-api-protection-waap-discovery-discovery-protection-protection/api-security-testing/ast-basics-and-workflow/scan-details/api-coverage.md).

# API Coverage

See which API endpoints an API Security Testing scan covered, and use the API Coverage tab to validate and improve scan coverage

The **API Coverage** tab provides details on how and which API endpoints Traceable exercised or covered during a scan, so you can understand which endpoints were tested, the thoroughness of testing, and whether any vulnerabilities were identified. This view helps you validate the effectiveness of your scan configurations and the reachability of your APIs.

## What you will learn from this topic

By the end of this topic, you will be able to understand:

* The details displayed in the **API Coverage** tab.
* The details displayed in the **Plugin Coverage** slide-out panel.
* The way you can use this data to validate and improve scan coverage.

***

## Before you begin

Make a note of the following before you review API coverage:

* Ensure that the scan has completed at least one run, as Traceable reports coverage per scan run. Go to [Scan Runs](https://developer.harness.io/web-application-and-api-protection-waap-discovery-discovery-protection-protection/api-security-testing/ast-basics-and-workflow/scan-details/scan-runs.md) for more details.
* Make sure that you understand traffic types, because the traffic type you select at scan creation determines which endpoints Traceable can cover. Go to [Understanding Scans and Traffic Types](https://developer.harness.io/web-application-and-api-protection-waap-discovery-discovery-protection-protection/api-security-testing/ast-basics-and-workflow/understanding-scans-and-traffic-types.md) for more details.

***

## Understand the API Coverage tab

The **API Coverage** tab displays a widget with API coverage (scanned and unscanned APIs) over the past seven scans, which you can use to track scanning consistency and validate scan progress. Below the widget, Traceable displays the API Coverage table for the selected scan run.

<figure><img src="https://1414883571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fdr7UJpJrdGkkSGT6AFTu%2Fuploads%2Fgit-blob-19e7742cb653de1ff75c1f0cb320b2f7eb4841cb%2Ftraceable_ast_scandetails_apicoverage.png?alt=media" alt=""><figcaption></figcaption></figure>

### API Coverage table

The table displays details for the latest scan run by default. From the top of the tab, you can select the scan run for which you want to view the API coverage details, and Traceable populates the table based on your selection. Traceable also displays the number of endpoints in the table.

The table includes the following columns:

| Column             | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Reachability**   | Displays whether the API is reachable (green dot <img src="https://1414883571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fdr7UJpJrdGkkSGT6AFTu%2Fuploads%2Fgit-blob-d31035324715110c9ab451cd045d668c1d8f9d1d%2Ftraceable_ast_scandetails_apicoverage_icon_green.png?alt=media" alt="" data-size="line">) or not reachable (red dot <img src="https://1414883571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fdr7UJpJrdGkkSGT6AFTu%2Fuploads%2Fgit-blob-701d42c60f786530a4748919c4117acda5402096%2Ftraceable_ast_scandetails_apicoverage_icon_red.png?alt=media" alt="" data-size="line">).                                                                                                                                               |
| **API Endpoint**   | Displays the name of the API endpoint scanned as part of the scan run.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| **Service**        | Displays the backend service or application that handles or exposes the API.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| **Domain**         | Displays the host extracted from the API endpoint's URL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| **Executed Tests** | <p>Displays the number of tests executed out of the total tests generated for the endpoint, as <em>executed tests/total tests</em>. Go to <a href="https://developer.harness.io/web-application-and-api-protection-waap-discovery-discovery-protection-protection/api-security-testing/ast-basics-and-workflow/scan-details/tests.md">Tests</a> for more details.<br>You can click a value under this column to open the <strong>Tests</strong> tab with <strong>Filter</strong> → <strong>API Endpoint</strong> set to the corresponding API endpoint.</p>                                                                                                                                                                                                                             |
| **Vulnerability**  | <p>Displays the total number of vulnerabilities detected on the endpoint. The breakdown by severity appears next to the total, color-coded in the following order: <em>Critical</em>, <em>High</em>, <em>Medium</em>, <em>Low</em>, and <em>Informational</em>.<br>You can click values under this column to view further details:</p><ul><li>Click the total vulnerability count to open the <strong>Issues</strong> tab with <strong>Filter</strong> → <strong>API Endpoint</strong> set to the corresponding API endpoint.</li><li>Click a severity level to open the <strong>Issues</strong> tab with <strong>Filter</strong> → <strong>API Endpoint</strong> set to the corresponding API endpoint, and <strong>Severity</strong> set to the severity level you clicked.</li></ul> |
| **Plugin**         | Displays the number of plugins that executed completely out of the total plugins identified for the endpoint, as *executed plugins/total plugins*. Click this value to open the **Plugin Coverage** slide-out panel. Go to [Understand the Plugin Coverage slide-out panel](#understand-the-plugin-coverage-slide-out-panel) for more details.                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| **Reason**         | Displays the reason if no tests were executed on the endpoint, for example, *No Traffic Received*.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |

{% hint style="info" %}
The **Plugin Coverage** slide-out panel is available only when you use CLI version *2.6.2* and above.
{% endhint %}

The table shows details for the latest scan by default. From the top of the tab, you can select the scan for which you want to view the API coverage details, and Traceable populates the table based on your selection.

### Actions in the API Coverage tab

Traceable provides the following actions in the API Coverage tab:

<table><thead><tr><th width="252.806396484375">Action</th><th>Description</th></tr></thead><tbody><tr><td><strong>Search</strong> bar</td><td>Locates an endpoint by typing its name.</td></tr><tr><td><strong>Filter</strong> icon</td><td>Refines the data shown in the tab by API name, reachability, vulnerability presence, or API scanning. After you apply a filter, you can save it for later use under <strong>Filter</strong> → <strong>Saved</strong>. Go to <a href="#filter-options">Filter options</a> for more details on the available filter options.</td></tr><tr><td><strong>Group By</strong> drop-down</td><td>Groups the data shown in the tab by <em>Domain, Reachability</em>, <em>Reason for Skipping</em>, or displays it ungrouped (<em>None</em>).</td></tr><tr><td><strong>Visualization</strong> toggle</td><td>Shows or hides the widget highlighting API coverage over the past 7 scans.</td></tr><tr><td><strong>Download</strong> icon</td><td>Downloads the list of APIs covered as a CSV file for offline analysis.</td></tr></tbody></table>

#### Filter options

The following filter options are available in the API covergae tab, helping you organise and view APIs according to your requirements:

| Filter                   | Description                                                                                                                            |
| ------------------------ | -------------------------------------------------------------------------------------------------------------------------------------- |
| **Domain**               | Specifies the domain associated with the endpoint, helping you narrow your findings to APIs within a specific domain or business area. |
| **API Name**             | Specifies the name of the API endpoint.                                                                                                |
| **API Reachability**     | Specifies the result of the API reachability, such as *Reachable, Unreachable* or *Authentication Failed.*                             |
| **Vulnerability Exists** | Specifies if vulnerabilities exist for the API endpoint.                                                                               |
| **Is API Scanned**       | Specifies if the API was scanned by Traceable.                                                                                         |

### Navigate to Tests and Issues tabs

Traceable pre-filters the destination tab when you click a value in the following columns:

* **Executed Tests:** Opens the **Tests** tab for the same scan run, with **Filter** → **API Endpoint** set to the corresponding API endpoint. Go to [Tests](https://developer.harness.io/web-application-and-api-protection-waap-discovery-discovery-protection-protection/api-security-testing/ast-basics-and-workflow/scan-details/tests.md) for more details.
* **Vulnerability** (total count): Opens the **Issues** tab with **Filter** → **API Endpoint** set to the corresponding API endpoint.
* **Vulnerability** (severity count): Opens the **Issues** tab with **Filter** → **API Endpoint** set to the corresponding API endpoint, and **Severity** set to the severity level you clicked.

***

## Understand the Plugin Coverage panel

The **Plugin Coverage** slide-out panel provides a detailed view of all the plugins that Traceable ran against a selected endpoint during the scan. You can access this panel by clicking the value in the **Plugin** column for an endpoint. Go to [Plugins](https://developer.harness.io/web-application-and-api-protection-waap-discovery-discovery-protection-protection/api-security-testing/advanced-usage/plugins.md) for more details.

<figure><img src="https://1414883571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fdr7UJpJrdGkkSGT6AFTu%2Fuploads%2Fgit-blob-82cf77ad8e6506cd10effdf1a14b41c579692652%2Ftraceable_ast_scandetails_apicoverage_pluginslideout.png?alt=media" alt=""><figcaption><p>Plugin Coverage for an API</p></figcaption></figure>

The panel displays a table with the following details:

<table><thead><tr><th width="212.728271484375">Column</th><th>Description</th></tr></thead><tbody><tr><td><strong>Plugin Name</strong></td><td>Displays the name of the plugin that Traceable executed against the API endpoint.</td></tr><tr><td><strong>Category</strong></td><td>Displays the vulnerability category associated with the plugin, for example, <em>tls</em>, <em>rce</em>, <em>authorization</em>, or <em>insecure_design</em>.</td></tr><tr><td><strong>Type</strong></td><td>Displays the type of plugin that Traceable used, for example, <em>Active</em>.</td></tr><tr><td><strong>Status</strong></td><td>Displays the number of issues detected by the plugin for the selected endpoint. The issues are grouped by <em>Ok</em> and <em>Not Ok.</em></td></tr><tr><td><strong>Plugin Duration</strong></td><td>Displays the time taken by the plugin to complete execution.</td></tr></tbody></table>

You can use the **Filter** icon at the top of the panel to refine the data displayed by **Plugin Name, Plugin Category** or **Plugin Type**. You can also use the **Download** icon to export the plugin coverage details for offline analysis.

***

## Leverage the data shown in the tab

The **API Coverage** tab helps you judge whether a scan tested the endpoints you care about, and what to change when it did not. The following scenarios show how to read the data and which action to take in each case.

Consider a scenario where you have set up a scan that targets critical APIs in the *HighTechApp* environment. After a few scans have completed, you open the **API Coverage** tab to validate the effectiveness of the scan configurations.

### Scenario 1: Endpoints with no executed tests

This scenario helps you identify endpoints that Traceable did not test because it received no matching traffic.

You identify that endpoints such as `POST /login` and `GET /transactions/get` have a high number of generated and executed tests, along with a number of identified issues (vulnerabilities), which highlights the effectiveness of the scan configurations. At the same time, endpoints such as `POST /users` and `POST /card/unblock` have *0 Executed Tests* and *No Traffic Received* as the reason. This indicates that these APIs were inactive during the scan or did not receive any traffic matching the traffic type you configured during scan creation.

In this scenario, you can do the following:

* Modify the traffic type for the scan based on where traffic is available for Traceable to scan the endpoint.
* Verify if the endpoints are still in use in your application ecosystem.

### Scenario 2: Endpoints with executed tests but no issues

This scenario helps you decide whether an endpoint with no identified issues is secure or under-tested.

You identify endpoints for which the number of executed tests is greater than *0*, and the number of identified issues (vulnerabilities) is *0*. If you think the API coverage is lower than expected for these endpoints, you can do the following:

* Validate or change the traffic type to represent real-world usage.
* Modify the policy (attack sets) that you want Traceable to use for testing the endpoints.
* Verify whether the defined authentications, if any, are blocking Traceable from thoroughly scanning the endpoints.

In both scenarios, you can click the value in the **Plugin** column to open the **Plugin Coverage** slide-out panel and identify which plugins ran successfully, which ones detected issues, and how long each plugin took to execute. This helps you fine-tune the policy and understand where coverage gaps may exist.

***

## Resume scan analysis

Once you have reviewed coverage, you can continue your analysis in the other tabs of the Scan Details page:

* To see why an endpoint was never eligible for testing, open the **Reachability Tests** tab. Go to [Reachability Tests](https://developer.harness.io/web-application-and-api-protection-waap-discovery-discovery-protection-protection/api-security-testing/ast-basics-and-workflow/scan-details/reachability-tests.md) for more details.
* To review the individual tests executed against a covered endpoint, open the **Tests** tab. Go to [Tests](https://developer.harness.io/web-application-and-api-protection-waap-discovery-discovery-protection-protection/api-security-testing/ast-basics-and-workflow/scan-details/tests.md) for more details.
* To review the vulnerabilities these tests detected, open the **Issues** tab. Go to [Issues](https://developer.harness.io/web-application-and-api-protection-waap-discovery-discovery-protection-protection/api-security-testing/ast-basics-and-workflow/scan-details/issues.md) for more details.
* To compare coverage across executions of this scan, open the **Scan Runs** tab. Go to [Scan Runs](https://developer.harness.io/web-application-and-api-protection-waap-discovery-discovery-protection-protection/api-security-testing/ast-basics-and-workflow/scan-details/scan-runs.md) for more details.
