Get dashboard figures

The dashboard for a period: last run, suite stability, time lost, the two test-metric tiles (testMetrics), slowest tests, time sinks, recent runs. Every figure counts finished runs of the source - all by default - and testMetrics.population names it. Moderate: aggregate queries over the period’s finished runs, run in the database - no result rows are loaded.

GET/api/v1/projects/{projectId}/overview

Parameters

Parameter	Description
`projectId`string · pathrequired	A project id from GET /projects.
`days`7 \| 14 \| 30 \| 90 · default 30	The period, in days, ending now. Must not exceed the plan’s retention (Standard 60, Pro 90 days); a longer period is refused with 400 invalid_period rather than answered with less data.
`branch`string	Exact branch name: every figure counts that branch’s runs. Every branch when absent or all (since 1.0.0-beta.17; it took stable or all, default stable, before - stable is now a 400).
`source`ci \| local \| all · default all	Which runs count, by where they ran: all - every run (the default since 1.0.0-beta.18; ci before); ci - runs a shard reported a CI provider for; local - runs no shard did. The response’s population names the one counted.

Request

BASE="https://app.squally.dev/api/v1"
URL="$BASE/projects/$PROJECT/overview"
curl "$URL" \
  -H "Authorization: Bearer $SQUALLY_API_KEY"

const base = "https://app.squally.dev/api/v1";
const key = process.env.SQUALLY_API_KEY;
const url = `${base}/projects/${projectId}`
  + `/overview`;
const response = await fetch(url, {
  headers: { Authorization: `Bearer ${key}` },
});
const data = await response.json();

import os
import requests

base = "https://app.squally.dev/api/v1"
key = os.environ["SQUALLY_API_KEY"]
url = f"{base}/projects/{project_id}/overview"
response = requests.get(
    url,
    headers={"Authorization": f"Bearer {key}"},
)
data = response.json()

{
  "project": {
    "id": "3f7c2a91-5b8e-4d0a-9c61-2e4b7f0d8a…",
    "name": "storefront-web"
  },
  "window": {
    "days": 30,
    "from": "2026-08-25T08:00:00.000Z",
    "to": "2026-09-24T08:00:00.000Z"
  },
  "branch": "main",
  "lastRun": {
    "id": "b1e0c6d2-7a43-4f19-8d5e-0c3a9e6f2b…",
    "runNumber": 1284,
    "branch": "main",
    "status": "passed",
    "startedAt": "2026-09-24T07:31:12.000Z",
    "finishedAt": "2026-09-24T07:39:47.000Z",
    "total": 412,
    "passed": 404,
    "flaky": 4,
    "failed": 0,
    "skipped": 4
  },
  "runsInWindow": 11,
  "unfinishedRuns": 1,
  "suiteSize": 412,
  "windowStability": 99,
  "timeLost": {
    "lostMs": 5112000,
    "lostPercent": 2.4,
    "wastedAttempts": 71,
    "wallClockMs": 213000000
  },
  "failingTests": {
    "failing": 1,
    "testsRun": 412
  },
  "testMetrics": {
    "population": "ci_groups_finished_not_mas…",
    "days": 30,
    "flakyTests": 7,
    "failingTests": 2,
    "tests": 409
  },
  "slowestTests": [
    {
      "testName": "chromium > checkout.spec.t…",
      "filePath": "tests/checkout.spec.ts",
      "medianMs": 14820,
      "runs": 57
    }
  ],
  "timeSinks": [
    {
      "testName": "chromium > checkout.spec.t…",
      "filePath": "tests/checkout.spec.ts",
      "lostMs": 1968000
    }
  ],
  "runsSeries": [
    {
      "runNumber": 1277,
      "passed": 408,
      "failed": 1,
      "durationMs": 498000
    },
    {
      "runNumber": 1284,
      "passed": 408,
      "failed": 0,
      "durationMs": 515000
    }
  ]
}

{
  "error": "sha must be 4 to 40 hexadecimal c…",
  "code": "invalid_parameter"
}

{
  "error": "Invalid read key.",
  "code": "invalid_key"
}

{
  "error": "This organization has been delete…",
  "code": "organization_deleted"
}

{
  "error": "No project with this id in this o…",
  "code": "project_not_found"
}

{
  "error": "Too many requests with this read …",
  "code": "rate_limited"
}

{
  "error": "Something went wrong on our side.",
  "code": "internal_error"
}

Example values. The shape is generated from the API schema.

Ask about this pageChatGPT Claude

Responses

200400401403404429500

Read API

API reference

Get dashboard figures

Parameters

Responses