Test Results

API Reference - Test Results

This resource allows you to query test results based on their signature.

Learn how to generate Test Signature before using this resource

Get Test Results

GET v1/test-results/:signature

Path Parameters

Name	Type	Description
signature*	string	Unique test signature. See Test Signature

Query Parameters

Name	Type	Description
date_start*	string (ISO 8601)	Start date for filtering test results within the specified date range
date_end*	string (ISO 8601)	End date for filtering test results within the specified date range
starting_after	string	Pagination cursor for fetching results after this cursor. See Pagination
ending_before	string	Pagination cursor for fetching results before this cursor. See Pagination
limit	number	Maximum number of results to return (1-100). Default: 10
branch[]	string	Filter by Git branch names. Multiple values: branch[]=valueA&branch[]=valueB
tag[]	string	Filter by tag names. Multiple values: tag[]=valueA&tag[]=valueB
git_author[]	string	Filter by Git author names. Multiple values: git_author[]=valueA&git_author[]=valueB
group[]	string	Filter by group names. Multiple values: group[]=valueA&group[]=valueB
status[]	enum	Test status filter. Values: "failed", "passed", "pending", "skipped". Multiple values: status[]=failed&status[]=passed

Response

200: OK Successful Response

{
  "status": "OK",
  "has_more": false,
  "data": [
    {
      "cursor": "67b8dac9413406575084b5b0",
      "signature": "a298aed2635166ffd75a5a88d29aaba4",
      "framework": {
        "clientVersion": "1.9.0",
        "type": "pw",
        "version": "1.49.0"
      },
      "createdAt": "2025-02-21T19:57:41.437Z",
      "projectId": "C3lBM6",
      "groupId": "Project A",
      "runId": "1aadb82f23eec93c",
      "instanceId": "Kw9tznsG3FUqMkGX",
      "spec": "1-failing.spec.ts",
      "machineId": "Iod3wzFiqQUF",
      "tags": ["basic"],
      "title": ["basic test @basic"],
      "testId": "57ab34a754efae6a0981-782e8b09a9c1dd694d18",
      "displayError": "Error: Timed out 5000ms waiting for expect(locator).toHaveText(expected)\n\nLocator: locator('.todo-list')\nExpected string: \"Learn Playwright\"\nReceived string: \"Learn JavaScript\"\nCall log:\n  - expect.toHaveText with timeout 5000ms\n  - waiting for locator('.todo-list')\n    9 × locator resolved to <ul class=\"todo-list\">…</ul>\n      - unexpected value \"Learn JavaScript\"",
      "commit": {
        "branch": "test-staging-pr",
        "authorEmail": "[email protected]",
        "authorName": "John Smith",
        "sha": "768c70d1946661182e5029c35169405e9c0c0473",
        "message": "Testing staging PR"
      },
      "duration": 18658,
      "flaky": false,
      "expectedStatus": "passed",
      "status": "failed",
      "attempts": [
        {
          "attemptId": "xUFASNJTFZ0B79Pt-0",
          "state": "failed",
          "error": {
            "message": "Error: Timed out 5000ms waiting for expect(locator).toHaveText(expected)\n\nLocator: locator('.todo-list')\nExpected string: \"Learn Playwright\"\nReceived string: \"Learn JavaScript\"\nCall log:\n  - expect.toHaveText with timeout 5000ms\n  - waiting for locator('.todo-list')\n    9 × locator resolved to <ul class=\"todo-list\">…</ul>\n      - unexpected value \"Learn JavaScript\"",
            "stack": "Error: Timed out 5000ms waiting for expect(locator).toHaveText(expected)\n\nLocator: locator('.todo-list')\nExpected string: \"Learn Playwright\"\nReceived string: \"Learn JavaScript\"\nCall log:\n  - expect.toHaveText with timeout 5000ms\n  - waiting for locator('.todo-list')\n    9 × locator resolved to <ul class=\"todo-list\">…</ul>\n      - unexpected value \"Learn JavaScript\"\n\n    at /Users/agoldis/playwright-gh-actions-demo/basic/1-failing.spec.ts:13:26",
            "location": {
              "line": 13,
              "column": 26,
              "file": "/Users/agoldis/playwright-gh-actions-demo/basic/1-failing.spec.ts"
            }
          },
          "startedAt": "2025-02-21T19:57:41.437Z",
          "duration": 6482
        },
        {
          "attemptId": "xUFASNJTFZ0B79Pt-1",
          "state": "failed",
          "error": {
            "message": "Error: Timed out 5000ms waiting for expect(locator).toHaveText(expected)\n\nLocator: locator('.todo-list')\nExpected string: \"Learn Playwright\"\nReceived string: \"Learn JavaScript\"\nCall log:\n  - expect.toHaveText with timeout 5000ms\n  - waiting for locator('.todo-list')\n    9 × locator resolved to <ul class=\"todo-list\">…</ul>\n      - unexpected value \"Learn JavaScript\"",
            "stack": "Error: Timed out 5000ms waiting for expect(locator).toHaveText(expected)\n\nLocator: locator('.todo-list')\nExpected string: \"Learn Playwright\"\nReceived string: \"Learn JavaScript\"\nCall log:\n  - expect.toHaveText with timeout 5000ms\n  - waiting for locator('.todo-list')\n    9 × locator resolved to <ul class=\"todo-list\">…</ul>\n      - unexpected value \"Learn JavaScript\"\n\n    at /Users/agoldis/playwright-gh-actions-demo/basic/1-failing.spec.ts:13:26",
            "location": {
              "line": 13,
              "column": 26,
              "file": "/Users/agoldis/playwright-gh-actions-demo/basic/1-failing.spec.ts"
            }
          },
          "startedAt": "2025-02-21T19:57:48.278Z",
          "duration": 5760
        },
        {
          "attemptId": "xUFASNJTFZ0B79Pt-2",
          "state": "failed",
          "error": {
            "message": "Error: Timed out 5000ms waiting for expect(locator).toHaveText(expected)\n\nLocator: locator('.todo-list')\nExpected string: \"Learn Playwright\"\nReceived string: \"Learn JavaScript\"\nCall log:\n  - expect.toHaveText with timeout 5000ms\n  - waiting for locator('.todo-list')\n    9 × locator resolved to <ul class=\"todo-list\">…</ul>\n      - unexpected value \"Learn JavaScript\"",
            "stack": "Error: Timed out 5000ms waiting for expect(locator).toHaveText(expected)\n\nLocator: locator('.todo-list')\nExpected string: \"Learn Playwright\"\nReceived string: \"Learn JavaScript\"\nCall log:\n  - expect.toHaveText with timeout 5000ms\n  - waiting for locator('.todo-list')\n    9 × locator resolved to <ul class=\"todo-list\">…</ul>\n      - unexpected value \"Learn JavaScript\"\n\n    at /Users/agoldis/playwright-gh-actions-demo/basic/1-failing.spec.ts:13:26",
            "location": {
              "line": 13,
              "column": 26,
              "file": "/Users/agoldis/playwright-gh-actions-demo/basic/1-failing.spec.ts"
            }
          },
          "startedAt": "2025-02-21T19:57:54.406Z",
          "duration": 5689
        }
      ]
    }
  ]
}

400: Bad Request Invalid parameters

{
    "status": "FAILED",
    "error": "date_start and date_end are required parameters"
}

401: Unauthorized Invalid API key

{
    "status": "FAILED",
    "error": "Invalid API key provided"
}

403: Forbidden Insufficient permissions

{
    "status": "FAILED",
    "error": "Insufficient permissions to access test results"
}

404: Not Found Test signature not found

{
    "status": "FAILED",
    "error": "Test signature not found"
}

Test

Name	Type	Description
cursor	string	Pagination cursor for this result. See Pagination
projectId	string	Project ID for this test. See Projects
groupId	string	Group ID that this test belongs to
runId	string	Run ID that this test belongs to. See Runs
instanceId	string	Instance ID that this test belongs to. See Instances
spec	string	Spec file name that contains this test. See Spec Files Explorer - API
machineId	string	Machine ID that executed this test
signature	string	Test signature. See Test Signature
title	string[]	Test title. See test title
testId	string	Test ID as reported by the testing framework
expectedStatus	enum	Expected status of the test. Values: "failed", "passed", "pending", "skipped". Only available for Playwright.
status	enum	Final status of the test after the execution. Values: "failed", "passed", "pending", "skipped"
framework	Framework	Information about the framework and reporter used for the test execution Framework
displayError	string	Most recent error message from test execution
commit	Commit	Git commit information Commit
createdAt	string (ISO 8601)	Timestamp when the test was executed
duration	number	Total duration of the test execution in milliseconds
flaky	boolean	Indicates whether the test is marked as flaky. See Flaky Tests
attempts	Attempt[]	List of test execution attempts Attempt
annotations	Annotation[]	List of test annotations Annotation

Commit

Name	Type	Description
branch	string	Git branch name for this test result
authorEmail	string	Git commit author email address
authorName	string	Git commit author name
sha	string	Git commit SHA hash
message	string	Git commit message

Framework

Name	Type	Description
clientVersion	string	Version of the reporter used for test execution
type	enum	Type of the test execution framework. Values: "pw", "cypress", "jest", "postman", "vitest"
version	string	Version of the testing framework

Annotation

Name	Type	Description
type	string	Type of the annotation
description	string	Description of the annotation

Attempt

Name	Type	Description
attemptId	string	Unique identifier for this test attempt
state	enum	Status of the attempt. Values: "failed", "passed", "pending", "skipped"
startedAt	string (ISO 8601)	Timestamp when the attempt started
duration	number	Total duration of the attempt in milliseconds
error	Error	Error object of the attempt in case of failure Error

Error

Name	Type	Description
message	string	Error description
stack	string	Detailed error description with stack trace
location	Location	Code location where the error occurred. See Location

Location

Name	Type	Description
line	number	Line number where the error occurred
column	number	Column number where the error occurred
file	string	File path where the error occurred