Read the project overview from the CLI
Print a Qualflare project's Overview dashboard numbers with qf overview as JSON, over the last 7 or 28 days, with each number's change and daily values.
Last updated
To read a project's Overview dashboard numbers in Qualflare from a terminal or a script, run qf <identifier> overview; you need the Viewer role or higher on the project. It prints six numbers as JSON: success rate, flake rate, launch p90, automation, defects opened and launches.
Before you begin
- qf installed (Install qf) and an identifier saved for the project with qf login.
- The Viewer role or higher on the project, as for every read command.
Print the overview
qf overview covers the last 7 days by default, or the last 28 with --days 28:
qf myapp overview
qf myapp overview --days 28 | jq '.kpis[] | {key, latest, previous, trend}'| Flag | Type | Default | Description |
|---|---|---|---|
--days | int | 7 | Window in days: 7 or 28 |
Output fields
The qf overview output has four parts:
window(from,toanddays) andbuckets, one UTC day each, oldest first.kpis, one entry per number, each withkey,label,unit,latest,previous,percentChange,trend,targetandvalues. The keys aresuccessRate,flakeRate,launchP90,automationRate,defectsOpenedandlaunches.unitispercent(0 to 100),secondsorcount.warnings, notes about the data.dataThrough, how current the numbers are. They lag a finished run by a few minutes.
Each number in kpis reads as follows:
latestis the most recent day with a reading, not a total over the window. FordefectsOpenedandlaunches, it is today's UTC count so far.previousis the daily average over the same number of days before the window, andpercentChangecompares the two.trendisup,down,none(a change of 0.1% or less) orneutral(nothing earlier to compare with). It gives the direction only, so a rising flake rate isuptoo.targetis the project's target,nullwhen none is set and alwaysnullfor the two counts.valuesholds one reading per bucket,nullon a day without one.
Troubleshoot
--days must be 7 or 28: the flag takes only those two values, and qf refuses any other before it sends a request.
dataThrough is null, or the numbers stay at zero after a run: the numbers lag a finished run by a few minutes. null means the time of the latest update couldn't be read. Run the command again a few minutes later.
Exit code 3, 4 or 5: the same causes as for any read command; see Exit codes.
Related
- Guides: Overview dashboard · Query project data from the CLI
- CLI/API: qf command reference · Configuration · Project overview API
Query project data from the CLI
List and get suites, cases, steps, test plans, launches, defects, failure clusters and milestones with the Qualflare CLI, as JSON you can filter with jq.
Troubleshoot qf and CI uploads
Fix Qualflare CLI and CI upload errors: what each qf exit code means, the exact messages for tokens, environments, formats and timeouts, and how to fix them.