Get test metrics

One test’s metrics over the period: the fields of its /tests row, flat, beside the same period. A test with results but no run of the source in the period answers zeros and null rates rather than 404. Cheap: the list’s queries, narrowed to one test; prefer it to /tests when the question is about one test.

GET/api/v1/projects/{projectId}/tests/{testName}/metrics

Parameters

Parameter	Description
`projectId`string · pathrequired	A project id from GET /projects.
`testName`string · pathrequired	The full test name as Squally stores it (Playwright’s title path). URL-encode it, including “/” as %2F. A name used in several spec files needs ?filePath=.
`filePath`string	The spec file of the test, as stored (e.g. tests/checkout.spec.ts); an empty value means a test with no file. Needed only when the name exists in several files - the 400 ambiguous_test answer lists them.
`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	Only runs on this branch, the name exactly. Every branch when absent.
`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/tests/$TEST_NAME"
URL="$URL/metrics"
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}`
  + `/tests/${testName}/metrics`;
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}/tests"
    f"/{test_name}/metrics"
)
response = requests.get(
    url,
    headers={"Authorization": f"Bearer {key}"},
)
data = response.json()

{
  "project": {
    "id": "3f7c2a91-5b8e-4d0a-9c61-2e4b7f0d8a…",
    "name": "storefront-web"
  },
  "population": "ci_groups_finished_not_mass_…",
  "days": 30,
  "since": "2026-08-25T08:00:00.000Z",
  "until": "2026-09-24T08:00:00.000Z",
  "branch": null,
  "testName": "chromium > checkout.spec.ts > …",
  "filePath": "tests/checkout.spec.ts",
  "browser": "chromium",
  "runs": 8,
  "stableRuns": 4,
  "flakyRuns": 4,
  "failedRuns": 0,
  "stability": 0.5,
  "flakyRate": 0.5,
  "failureRate": 0,
  "timeLostMs": 7361,
  "recentResults": [
    {
      "runId": "5c8e2a17-9d4b-4f60-b3a1-7e2d9…",
      "runNumber": 1261,
      "startedAt": "2026-09-12T07:30:41.000Z",
      "branch": "main",
      "result": "stable"
    },
    {
      "runId": "c2e7a940-5d1b-4f8e-9a36-0b4d7…",
      "runNumber": 1264,
      "startedAt": "2026-09-14T15:12:09.000Z",
      "branch": "feature/saved-carts",
      "result": "flaky"
    },
    {
      "runId": "a3f19c62-0e7d-4b85-9c24-6d1e8…",
      "runNumber": 1266,
      "startedAt": "2026-09-15T07:31:03.000Z",
      "branch": "main",
      "result": "flaky"
    },
    {
      "runId": "d07b4e95-6a2c-4e13-8f5d-2b9c1…",
      "runNumber": 1270,
      "startedAt": "2026-09-17T07:29:58.000Z",
      "branch": "main",
      "result": "flaky"
    },
    {
      "runId": "6b1f8d23-9e4a-4c07-b5d2-3a8e0…",
      "runNumber": 1273,
      "startedAt": "2026-09-18T11:47:35.000Z",
      "branch": "feature/saved-carts",
      "result": "stable"
    },
    {
      "runId": "8f6a3d21-4c9e-4a7b-b052-e1d7c…",
      "runNumber": 1277,
      "startedAt": "2026-09-20T07:32:16.000Z",
      "branch": "main",
      "result": "stable"
    },
    {
      "runId": "7d2f4b19-3c8e-4a61-9e07-5b1d8…",
      "runNumber": 1283,
      "startedAt": "2026-09-23T16:05:40.000Z",
      "branch": "feature/saved-carts",
      "result": "stable"
    },
    {
      "runId": "b1e0c6d2-7a43-4f19-8d5e-0c3a9…",
      "runNumber": 1284,
      "startedAt": "2026-09-24T07:31:12.000Z",
      "branch": "main",
      "result": "flaky"
    }
  ],
  "branches": [
    "feature/saved-carts",
    "main"
  ],
  "topBranch": {
    "branch": "main",
    "kind": "retries",
    "count": 3
  }
}

{
  "error": "Several tests have this name. Pas…",
  "code": "ambiguous_test"
}

{
  "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 test metrics

Parameters

Responses