Get a run

Get a run with all its tests. One logical run and every test’s final attempt. Any shard’s id works: a sharded run is answered for all its shards, each test naming the shard that ran it. Moderate: reads every result of the run.

GET/api/v1/projects/{projectId}/runs/{runId}

Parameters

Parameter	Description
`projectId`string · pathrequired	A project id from GET /projects.
`runId`string · pathrequired	A run id from GET /projects/{projectId}/runs - or any shard’s id of a sharded run.

Request

BASE="https://app.squally.dev/api/v1"
URL="$BASE/projects/$PROJECT/runs/$RUN_ID"
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}`
  + `/runs/${runId}`;
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}/runs"
    f"/{run_id}"
)
response = requests.get(
    url,
    headers={"Authorization": f"Bearer {key}"},
)
data = response.json()

{
  "project": {
    "id": "3f7c2a91-5b8e-4d0a-9c61-2e4b7f0d8a…",
    "name": "storefront-web"
  },
  "run": {
    "id": "b1e0c6d2-7a43-4f19-8d5e-0c3a9e6f2b…",
    "runNumber": 1284,
    "branch": "main",
    "commitSha": "3b5d8e2f9a1c4e7b0d6f2a8c5e1…",
    "commitMessage": "Show the discounted tot…",
    "authorName": "release-bot",
    "testedRevision": null,
    "pullRequestNumber": null,
    "pullRequestTitle": null,
    "ciProvider": "github-actions",
    "status": "passed",
    "cancellation": null,
    "local": false,
    "settled": true,
    "jobKey": null,
    "attempt": 1,
    "rerunOf": null,
    "ciRunUrl": "https://github.com/example-s…",
    "startedAt": "2026-09-24T07:31:12.000Z",
    "finishedAt": "2026-09-24T07:39:47.000Z",
    "durationMs": 515000,
    "shards": {
      "expected": 2,
      "received": [
        {
          "runId": "b1e0c6d2-7a43-4f19-8d5e-0…",
          "index": 1,
          "runState": "completed",
          "status": "passed"
        },
        {
          "runId": "e4a9d3f0-2b6c-4178-a5d1-9…",
          "index": 2,
          "runState": "completed",
          "status": "passed"
        }
      ]
    }
  },
  "counts": {
    "total": 412,
    "passed": 408,
    "failed": 0,
    "skipped": 3,
    "flaky": 1
  },
  "tests": [
    {
      "testName": "chromium > checkout.spec.t…",
      "filePath": "tests/checkout.spec.ts",
      "status": "passed",
      "attempts": 2,
      "durationMs": 1840,
      "errorMessage": null,
      "fingerprint": null,
      "browserName": "chromium",
      "timedOut": false,
      "timeoutMs": 30000,
      "shard": {
        "index": 1,
        "runId": "b1e0c6d2-7a43-4f19-8d5e-0c3a…"
      },
      "annotations": [
        "issue"
      ],
      "location": {
        "line": 41,
        "column": 5
      }
    },
    {
      "testName": "chromium > search.spec.ts …",
      "filePath": "tests/search.spec.ts",
      "status": "passed",
      "attempts": 1,
      "durationMs": 2310,
      "errorMessage": null,
      "fingerprint": null,
      "browserName": "chromium",
      "timedOut": false,
      "timeoutMs": 30000,
      "shard": {
        "index": 2,
        "runId": "e4a9d3f0-2b6c-4178-a5d1-9f0e…"
      },
      "annotations": [],
      "location": {
        "line": 18,
        "column": 3
      }
    }
  ]
}

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

200401403404429500

Read API

API reference

Get a run

Parameters

Responses