Using the API Test Views
View your ThousandEyes API test results using the API test type view, which is designed to give you both high-level insights and detailed diagnostics.
The API test results highlights:
Correlate with Other Tests: If you see issues (e.g., high latency), switch to a Network or Web test on the same target to isolate the cause.
Response Body: For troubleshooting, inspect the response body in the step details—especially if assertions fail or errors occur.
Agent Perspective: Compare results across Cloud Agents (global) and Enterprise Agents (internal) to spot regional or network-specific problems.
View Specifics
From the Tests section of the ThousandEyes app, find the API test you want to view in the test list. You can filter by test type (select the checkbox next to “API”) or search by name if you’ve got many tests. Click the test name to open its results.
Timeline View
At the top, you’ll see a timeline graph showing metrics over time (e.g., the last hour, day, or custom range). API Transaction Time and API Completion are plotted here.
Use the time picker to zoom in or out (e.g., last 24 hours, 7 days, etc.).
Select additional metrics using the metric selection menu above the timeline.
API Test Metrics
API Transaction Time - timeline shows a breakout of the total time taken by all of the API calls that run sequentially in an API test, averaged across each agent. If total time is slower than normal, you should see a spike in the API Transaction time.
API Completion - a percentage value indicating the number of API calls that succeeded in the selected test round. The API completion metric is helpful for understanding whether the API is performing as expected.
More precisely, API completion is calculated as the number of API steps (API calls) that received a response and did not fail any assertions, divided by the total number of API steps in the test. This number is then averaged across each agent. For example:
In a 1-step test, API completion will be either 100% (one out of one steps) or 0% (zero out of one steps).
In a 2-step API test, API Completion is either 100% (2 out of 2 steps), 50% (1 out of 2 steps), or 0% (0 out of 2 steps).
The ratios adjust accordingly for the number of steps in the test.
Map Tab
Below the timeline, a world map displays the locations of the agents running your test. Each agent’s status is color-coded (green for good, red for errors), with metrics like average response time or completion status shown per location.
Hover over an agent dot to see quick stats or click to drill down into that agent’s data.
Table Tab
A table lists detailed metrics for each agent, including:
Agent
Date
API Transaction Time
API Completion
Errors
Sort or filter this table to focus on specific agents or metrics.
Details Tab
The API test view Details tab lists all the API calls in the test, along with transaction times. Note that this tab shows times for a single test round, as selected in the timeline above. Clicking a step displays the request and response details for the test round selected in the timeline above.
The Details tab shows a step-by-step breakdown if your API test has multiple steps:
Response codes (e.g., 200 OK, 404 Not Found).
Timing for each step.
Assertion results (pass/fail based on your validation rules).
You can expand each step to see the full request/response details, including headers and body (JSON, etc.).
API Test Request and Response Details
When you click a step in the view’s Details tab, a modal appears with further details including the response code for that API call, the time it took for the API call to complete, and a summary of results for assertion rules, if any custom rules were configured. Both request and response will have headers and, sometimes, body as well.
API Test Response Body
Note that Body only displays if the check box for Collect Response from this API Step was selected in the Post-Request Options tab for this step.
The following must be true:
The HTTP response contains a Content-Type header that is supported, and
The Collect Response from this API Step is selected in the Post-Request Options tab
If either of those are not true, then the response body contents do not display in the test view.
Supported API Test Content Types
ThousandEyes only supports text-formatted responses to display on the Body portion of the API test view detail modal. Other formats such as media files can’t be coherently displayed in a text editor. If Collect Response from this API Step is checked in the Step Builder, but the test view details modal still doesn't show the response body, that means that the response body included an unsupported format.
Last updated