API Testing: Run History
Overview
Use this page to review and filter API flow run history, and delete run records. A flow is a saved sequence of API requests that LoadGen executes as a single test; every time a flow runs, whether started manually or on a schedule, it produces a run, a timestamped record of what happened. Run History is the execution log for every one of those runs: it shows whether each run's steps passed or failed, how long the run took, and lets you narrow a growing history down to the runs that matter.
Flows themselves are created and configured on API Testing: Flows, and most of the runs listed here come from manually starting a flow or from a recurring schedule set up on API Testing: Schedules. Run records are kept only for a limited window, controlled by the setting on Configuration: API Testing: Retention; once a run ages past that window it is purged automatically, which is why this page also lets you delete records yourself ahead of time.
On this page you can filter the run list by flow, outcome, and date range, open the flow behind any run, and remove individual or multiple run records permanently.
Key concepts
- Flow - A saved sequence of API requests that executes as a single test; this page records every time one is run. (related: API Testing: Flows)
- run - A single recorded execution of a flow, capturing when it started, how long it took, and how many of its steps passed or failed. (related: API Testing: Flows)
- State - The outcome of a run. Completed (passed) means every step succeeded; Failed means at least one step did not. These are the only outcomes you can search for in the State filter.
- Retention - The number of days the platform keeps run records before deleting them automatically, shown near the top of this page. (related: Configuration: API Testing: Retention)
When to use it
- To confirm whether a scheduled or manually started flow run passed or failed.
- To investigate a specific failed run by checking its pass/fail counts and duration.
- To audit a flow's execution history over a date range, for example before a release.
- To check how many days of run history remain before automatic deletion.
- To delete outdated or unneeded run records ahead of automatic retention cleanup.
Before you begin
- At least one API flow exists and has been run at least once, created and executed from API Testing: Flows (manually) or API Testing: Schedules (on a recurring basis); otherwise the table has nothing to show.
- Your account has permission to read API Testing run history; without it, the page shows a message explaining the refusal instead of a run list.
- To filter by a specific flow, your account must also be permitted to list flows; otherwise the Flow dropdown has no options, though the unfiltered run list still loads.
- To change the retention period shown near the top of the page, your account must be permitted to change it, with the change itself made on Configuration: API Testing: Retention.
Common workflows
Investigate a failed flow run
Persona: Load-test operator
- Open Run History from the API Testing section.
- Expect: The table loads the most recent runs across all flows, each row showing its Flow, State, Started time, Duration, and Pass/Fail counts.
- Select Failed from the State dropdown and select Search.
- Expect: The table reloads showing only runs whose State is Failed.
- Select the Flow link on the run you want to investigate.
- Expect: The flow's definition opens so you can review the steps that produced the failure.
Verify: The filtered list contains only Failed runs, and each visible row's Fail count is 1 or more, confirming at least one step in that run did not pass.
Delete outdated run records before retention expires
Persona: Load-test operator or admin
- Review the Retention notice near the top of the page.
- Expect: You see how many days of run history are kept automatically, and whether a count cap also applies.
- Select the checkboxes for the runs you no longer need, or select the header checkbox to select every row on the page.
- Expect: A bulk action bar with Delete selected appears, showing the number of runs checked.
- Select Delete selected and confirm the prompt.
- Expect: The confirmed runs are permanently removed and the table reloads without them.
Verify: The deleted runs no longer appear in the table; re-running Search with the same filters returns a shorter list than before.
Steps
Step 1
Open Run History under API Testing.
Expected result: The page loads showing runs for all flows with no filters applied: Flow is set to All Flows, State to All, and no date range is set. A Credentials expiring banner also appears, warning that an API credential profile expires in 4 days.
This unfiltered view is the starting point for reviewing or narrowing down run history.
- Flow filter defaults to All Flows.
- State filter defaults to All.
- Retention: 180 days · no count limit is shown near the top with a Change link.
- A Credentials expiring banner with a Dismiss control appears above the filters.
Step 2
Select Search without changing any filter.
Expected result: The table reloads with the same unfiltered run list, confirming that Search re-runs the query on demand. The Credentials expiring banner is no longer shown.
Running Search with the default filters confirms you're looking at the complete, current run history before narrowing it down.
- Search re-evaluates the Flow, State, From, and To values currently set.
-
Back to Flows is available to return to the flow list.
Field reference
| Field | Purpose | Format / Validation | Required | Default |
|---|---|---|---|---|
| Flow | Narrows the run list to a single flow. Leave it at All Flows to see every flow's runs together; choose a specific flow when you need to isolate its history, for example while investigating a particular test. | Dropdown populated from your configured flows | No | All Flows |
| State | Narrows the run list by outcome. Choose Completed (passed) to confirm a flow has succeeded; choose Failed to isolate runs that need investigation. Leave it at All to see both outcomes. | Dropdown | No | All |
| From | Sets the earliest start date a run must have to appear in the list. An earlier date widens the range further into the past; leaving it blank removes the lower bound. | Date, dd/mm/yyyy | No | - |
| To | Sets the latest start date a run must have to appear in the list. A later date widens the range toward the present; leaving it blank removes the upper bound, through now. | Date, dd/mm/yyyy | No | - |
| (select all rows) | Selects every run currently listed so you can delete several at once with a single confirmation instead of deleting them one by one. | Checkbox, header of the table | No | Unchecked |
Column reference
| Column | What it shows | How to read it |
|---|---|---|
| Flow | Identifies which flow produced this run. | The same flow name can repeat across many rows, once per run; select it to open that flow's definition. |
| State | Shows the run's outcome. | Failed means at least one step in the run did not pass. Completed (passed) means every step passed; it is not shown in the sample runs captured here, since every visible row is Failed. |
| Started | The date and time the run began. | Rows are listed most-recent-first by default; this is also the value the From/To filters match against. |
| Duration | How long the run took to execute. | Compare against other runs of the same flow to spot a run that took noticeably longer or shorter than usual. |
| Pass | Number of steps within the run that completed successfully. | Read alongside Fail: a Failed run can still show passing steps, which narrows down which part of the flow broke. |
| Fail | Number of steps within the run that did not complete successfully. | Any value of 1 or more corresponds to a State of Failed for that run. |
| Actions | Row-level action for this run. | Shows a trash-can icon that opens a delete confirmation for just this run. |
Controls reference
Search
Re-queries run history using the current Flow, State, From, and To values.
When to use: After changing any filter, or to refresh the list with its current filter values.
Side effects: Read-only: reloads the table; no run data is changed.
Clear filters
Resets Flow, State, From, and To back to their defaults (All Flows, All, no dates) and reloads the full run list.
When to use: When your current filters match zero runs and the page shows No runs match these filters, to quickly return to the complete list.
Side effects: Read-only: resets filter values and re-queries; no run data is changed.
Clear
Clears a single From or To date value.
When to use: To remove just one side of a date range without resetting the Flow or State filters.
Side effects: Read-only: only clears that field; the list does not refresh until you select Search.
Change
Opens the retention settings for API Testing run history.
When to use: When you need to extend or shorten how many days of run history are kept, or add or remove a count cap.
Side effects: Read-only on this page: navigates to Configuration: API Testing: Retention; it does not change or delete anything by itself.
Dismiss
Closes the Credentials expiring notification banner.
When to use: Once you've noted the expiring credential and don't need the reminder on screen.
Side effects: Read-only: hides the banner only; it does not renew or change the underlying credential.
Delete run
Opens a confirmation prompt naming the run's flow and start time, and permanently removes that single run record if you confirm.
When to use: To remove one obsolete or unneeded run record before its retention period ends.
Side effects: Mutating and destructive: permanently deletes the run and its pass/fail detail; cannot be undone.
Delete selected
Opens a confirmation prompt and permanently deletes every checked run record at once.
When to use: To clear out a batch of old or failed runs in one action instead of deleting them individually.
Side effects: Mutating and destructive: permanently deletes all checked runs; cannot be undone.
Previous
Moves to the previous page of run results.
When to use: When the run list has more rows than fit on one page and you want to go back.
Side effects: Read-only: changes which page is displayed; disabled on the first page.
Next
Moves to the next page of run results.
When to use: When the run list has more rows than fit on one page.
Side effects: Read-only: changes which page is displayed; disabled on the last page.
Back to Flows
Navigates back to the API Testing flow list.
When to use: Once you've finished reviewing a flow's run history and want to manage flows instead.
Side effects: Read-only navigation only.
Verify the result
A correctly filtered Run History table shows only runs matching your Flow, State, and date range selections, and each row's Pass and Fail counts are consistent with its State: any Failed run has a Fail count of 1 or more. If you delete a run, it disappears from the table immediately. If Search appears to do nothing, check that your filter values actually differ from what's already applied, since identical filters return an identical-looking list. If the table is empty with a red message above the filters instead of a No runs match these filters heading, your account lacks permission to read run history and the message explains why.
Troubleshooting
- Symptom: Selecting Search doesn't seem to change the list. Fix: Check whether Flow, State, From, and To actually differ from the current filters; identical filters return the identical result set.
- Symptom: The Flow dropdown has no options to choose from. Fix: Your account may not be permitted to list flows; you can still filter all runs you're allowed to see by State and date.
- Symptom: The table shows No runs match these filters. Fix: Select Clear filters to reset Flow, State, From, and To back to their defaults, then narrow the range again one filter at a time.
- Symptom: Deleting a run doesn't remove the row right away. Fix: Confirm the This cannot be undone prompt that appears after selecting the trash icon; the run is only deleted once you confirm it.
- Symptom: The Change link next to Retention isn't shown. Fix: Only accounts permitted to change the retention setting see this link; view or change it on Configuration: API Testing: Retention with an account that has that access.
- Symptom: A red message replaces the run list instead of an empty table. Fix: This means the read was refused outright, not that there are zero runs; confirm your account has access to API Testing run history.
Related articles
- Prerequisite: API Testing: Flows - a flow must exist and have been run before any history appears here
- See also: API Testing: Schedules - scheduled runs are a common source of new run records shown here
- See also: Configuration: API Testing: Retention - sets how many days of run history this page keeps before automatic deletion
- See also: Configuration: Credential Profiles - reissue an API credential flagged as expiring in this page's banner