Skip to content
The docs are now organized by product area. Old links still work. Report a broken link

Project overview API

Read a Qualflare project's Overview dashboard numbers over the REST API: six KPIs over 7 or 28 days, with their change, trend, targets and daily values.

Last updated

The Project overview API lets you read the six Overview dashboard numbers of a Qualflare project over REST at https://api.qualflare.com/api/v1/overview, for the last 7 days by default or the last 28.

Base path/api/v1/overview
ReadsAny token. Token creator: Viewer+ · project (requires the Viewer role or higher in the project). The endpoint changes nothing
Windowdays=7 (the default) or days=28, ending today (UTC)
Limits5 requests per second per access token or sign-in connection, bursts of up to 20 (Rate limits and request sizes)
ErrorsErrors and status codes
CLIqf <identifier> overview (Read the project overview from the CLI)
MCPNo MCP tool reads the overview

The one endpoint, with its own section below:

EndpointWhat it does
GET /api/v1/overviewGet the project overview

Get the project overview

Get the project overview returns the project's success rate, flake rate, launch p90, automation, defects opened and launches, each with its change from the period before and one reading per UTC day.

GET /api/v1/overview

Needs a project access token whose creator has the Viewer role or higher in the project.

NameTypeDefaultRequiredDescription
daysquery, integer7NoThe window in days, ending today (UTC): 7 or 28
curl -sS "https://api.qualflare.com/api/v1/overview?days=7" \
  -H "Authorization: Bearer $QF_TOKEN"

Returns 200: The project's six Overview numbers over the window: window, buckets, kpis, warnings and dataThrough.

{
  "window": { "from": "2026-11-15", "to": "2026-11-21", "days": 7 },
  "buckets": ["2026-11-15", "2026-11-16", "2026-11-17", "2026-11-18", "2026-11-19", "2026-11-20", "2026-11-21"],
  "kpis": [
    {
      "key": "successRate", "label": "Success rate", "unit": "percent",
      "latest": 97.5, "previous": 96, "percentChange": 1.5625, "trend": "up", "target": 95,
      "values": [95.1, 96, null, 94.2, 97.3, 96.8, 97.5]
    },
    {
      "key": "flakeRate", "label": "Flake rate", "unit": "percent",
      "latest": 1.5, "previous": 2, "percentChange": -25, "trend": "down", "target": 3,
      "values": [2.5, 1.8, null, 2.1, 1.6, 1.9, 1.5]
    },
    {
      "key": "launchP90", "label": "Launch p90", "unit": "seconds",
      "latest": 384, "previous": 400, "percentChange": -4, "trend": "down", "target": 420,
      "values": [412, 398, null, 425, 390, 405, 384]
    },
    {
      "key": "automationRate", "label": "Automation", "unit": "percent",
      "latest": 81, "previous": 75, "percentChange": 8, "trend": "up", "target": 85,
      "values": [76, 77, 77, 78, 79, 80, 81]
    },
    {
      "key": "defectsOpened", "label": "Defects opened", "unit": "count",
      "latest": 1, "previous": 1.25, "percentChange": -20, "trend": "down", "target": null,
      "values": [2, 0, 0, 1, 3, 0, 1]
    },
    {
      "key": "launches", "label": "Launches", "unit": "count",
      "latest": 2, "previous": 8, "percentChange": -75, "trend": "down", "target": null,
      "values": [6, 8, 0, 7, 9, 5, 2]
    }
  ],
  "warnings": [],
  "dataThrough": "2026-11-21T09:00:00Z"
}
  • Any other days, such as 30, answers 400 with common.invalid_input and days must be 7 or 28.
  • This endpoint has its own per-token limit, apart from the one on /mcp: over 5 requests per second, after a burst of up to 20, it answers 429 with common.rate_limited and a Retry-After header in seconds.
  • The numbers lag a finished run by a few minutes. dataThrough says how current they are.

Overview fields

Every answer of the Project overview API has these fields. Each is always sent: a value the project has no reading for is null, never left out.

FieldTypeNotes
windowobjectfrom and to (YYYY-MM-DD, UTC) and days
bucketsarray of stringsOne UTC day each, YYYY-MM-DD, oldest first
kpisarray of objectsThe six numbers, in this order: successRate, flakeRate, launchP90, automationRate, defectsOpened and launches
warningsarray of stringsNotes about the data, such as a window cut to the data Qualflare keeps; usually empty
dataThroughstringWhen the numbers were last updated, an RFC 3339 time; null when that can't be read

KPI fields

Each item of kpis in the Project overview API has these fields:

FieldTypeNotes
keystringsuccessRate, flakeRate, launchP90, automationRate, defectsOpened or launches
labelstringA display name: Success rate, Flake rate, Launch p90, Automation, Defects opened or Launches
unitstringpercent (0 to 100), seconds or count
latestnumberThe most recent day with a reading, not a total over the window. For defectsOpened and launches, today's UTC count so far
previousnumberThe daily average over the same number of days before the window
percentChangenumberThe change from previous to latest, in percent; null when there is nothing earlier to compare with
trendstringup, down, none (a change of 0.1% or less) or neutral (nothing earlier to compare with). It gives the direction only, so a rising flake rate is up too
targetnumberThe project's target from Settings > Quality, null when none is set and always null for the two counts
valuesarray of numbersOne reading per bucket, null on a day without one

CLI and MCP equivalents

The qf CLI sends the same request and prints the same fields as JSON; the MCP server has no tool for it:

RESTqf command and MCP tool
GET /api/v1/overviewqf <identifier> overview, with --days 28 for 28 days; no MCP tool