APIs related to Builds in Test Observability

The APIs related to Builds in Test Observability are listed below:

get build list

Use this API to retrieve a list of builds under a specific project. You can filter the runs by build names, tags, status, etc.

GET https://api-observability.browserstack.com/ext/v1/projects/{project_id}/builds

Request parameters

Request

curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
https://api-observability.browserstack.com/ext/v1/projects/825/builds

unique_build_names String

Specify the unique build names you want to retrieve the build runs for. Use the same build names as displayed in the Test Observability UI.
build_tags String

Filter builds by specific build tags.
build_status String

The build_status parameter filters your results by the status of the build. The values accepted are “passed”, “failed”, “unknown”, “skipped”, “running”.
users String

Filter the build runs by the user who created the build runs in Test Observability.
frameworks String

Filter builds by frameworks. Allowed values are “WebdriverIO”, “TestNG”, “Mocha”, “Nightwatch”, “Cypress”, “Playwright”, “JUnit5”, “Robot”, “Pytest”, “NUnit”, “Jest”, “Serenity”, “MSTest”, “CodeceptJS”
is_archived Boolean

Set this to true to fetch archived build runs. Default value if false.
date_range String

Mention the date range you want to fetch the build runs for. The Unix timestamp must be provided in milliseconds. Test Observability returns data for the last 7 days by default.
next_page String

Used to fetch subsequent pages of the build list. Pass the next_page reference received in the response of last request.

Response Attributes `200 OK` `JSON`

Response

{
    "id": 825,
    "name": "Test Observability Samples",
    "builds": [
        {
            "name": "wdio-cucumber-samples",
            "status": "failed",
            "duration": 254005,
            "user": "AKIIII",
            "tags": [
                "perf",
                "wdio"
            ],
            "build_id": "81yobvicuiuozd1bncaeegvubey7rbl8naevwets",
            "original_name": "wdio-cucumber-samples",
            "finished_at": "2024-05-08T12:49:48.656+00:00",
            "started_at": "2024-05-08T12:45:34.651+00:00",
            "status_stats": {
                "passed": 30,
                "failed": 24,
                "pending": 0,
                "skipped": 8,
                "unknown": 0
            },
            "build_number": 235,
            "is_archived": false,
            "observability_url": "https://observability.browserstack.com/projects/Test+Observability+Samples/builds/wdio-cucumber-samples/235"
        },
        {
            "name": "nightwatch-samples",
            "status": "running",
            "duration": null,
            "user": "AKIIII",
            "tags": [
                "qa",
                "sanity"
            ],
            "build_id": "zogwefyovnjihvtxpu9271ukmchnn8itivui4bw6",
            "original_name": "nightwatch-samples",
            "finished_at": null,
            "started_at": "2024-05-08T12:14:20.224+00:00",
            "status_stats": {
                "passed": 0,
                "failed": 0,
                "pending": 0,
                "skipped": 0,
                "unknown": 0
            },
            "build_number": 216,
            "is_archived": false,
            "observability_url": "https://observability.browserstack.com/projects/Test+Observability+Samples/builds/nightwatch-samples/216"
        },
        {
            "name": "wdio-mocha-samples",
            "status": "failed",
            "duration": 298244,
            "user": "AKIIII",
            "tags": [
                "perf",
                "wdio"
            ],
            "build_id": "n1el0tejpamj6kj7esmjwg5bq0n9w8il2ittc50d",
            "original_name": "wdio-mocha-samples",
            "finished_at": "2024-05-08T12:12:31.615+00:00",
            "started_at": "2024-05-08T12:07:33.371+00:00",
            "status_stats": {
                "passed": 35,
                "failed": 22,
                "pending": 0,
                "skipped": 20,
                "unknown": 0
            },
            "build_number": 251,
            "is_archived": false,
            "observability_url": "https://observability.browserstack.com/projects/Test+Observability+Samples/builds/wdio-mocha-samples/251"
        },
        {
            "name": "junit-valid zip",
            "status": "failed",
            "duration": 12000,
            "user": "AKIIII",
            "tags": [
                "p1",
                "p2"
            ],
            "build_id": "xuro4nyfv3zsyospp5scfwininr79jz5zffbioni",
            "original_name": "junit-valid zip",
            "finished_at": "2024-05-08T06:18:02.000+00:00",
            "started_at": "2024-05-08T06:17:50.000+00:00",
            "status_stats": {
                "passed": 203,
                "failed": 117,
                "pending": 0,
                "skipped": 0,
                "unknown": 0
            },
            "build_number": 232,
            "is_archived": false,
            "observability_url": "https://observability.browserstack.com/projects/Test+Observability+Samples/builds/junit-valid+zip/232"
        },
        {
            "name": "junit-valid-and-invalid zip",
            "status": "failed",
            "duration": 0,
            "user": "AKIIII",
            "tags": [
                "p1",
                "p2"
            ],
            "build_id": "fr4h0hwblcbev7k6cbajfjhd6j48joqoorghjtqs",
            "original_name": "junit-valid-and-invalid zip",
            "finished_at": "2024-05-08T11:46:50.390+00:00",
            "started_at": "2024-05-08T11:46:50.390+00:00",
            "status_stats": {
                "passed": 11,
                "failed": 2,
                "pending": 0,
                "skipped": 0,
                "unknown": 0
            },
            "build_number": 234,
            "is_archived": false,
            "observability_url": "https://observability.browserstack.com/projects/Test+Observability+Samples/builds/junit-valid-and-invalid+zip/234"
        },
        {
            "name": "junit-predated zip",
            "status": "skipped",
            "duration": 0,
            "user": "AKIIII",
            "tags": [
                "p1",
                "p2"
            ],
            "build_id": "vvjphna8cfi3ud1ga5whxivkcdp0cassplyxe667",
            "original_name": "junit-predated zip",
            "finished_at": "2024-05-08T11:45:50.001+00:00",
            "started_at": "2024-05-08T11:45:50.001+00:00",
            "status_stats": {
                "passed": 0,
                "failed": 0,
                "pending": 0,
                "skipped": 0,
                "unknown": 0
            },
            "build_number": 234,
            "is_archived": false,
            "observability_url": "https://observability.browserstack.com/projects/Test+Observability+Samples/builds/junit-predated+zip/234"
        },
        {
            "name": "junit-valid-big xml",
            "status": "failed",
            "duration": 4000,
            "user": "AKIIII",
            "tags": [
                "p1",
                "p2"
            ],
            "build_id": "7pdldfwgkzdvxlbrkqpulwbevn1opvbtjgenupqx",
            "original_name": "junit-valid-big xml",
            "finished_at": "2024-05-08T06:14:51.000+00:00",
            "started_at": "2024-05-08T06:14:47.000+00:00",
            "status_stats": {
                "passed": 200,
                "failed": 102,
                "pending": 0,
                "skipped": 0,
                "unknown": 0
            },
            "build_number": 237,
            "is_archived": false,
            "observability_url": "https://observability.browserstack.com/projects/Test+Observability+Samples/builds/junit-valid-big+xml/237"
        },
        {
            "name": "junit-valid xml",
            "status": "failed",
            "duration": 12000,
            "user": "AKIIII",
            "tags": [
                "p1",
                "p2"
            ],
            "build_id": "7opdlwbliczzm2sjk26jqh38lay00jypeqqagcf8",
            "original_name": "junit-valid xml",
            "finished_at": "2024-05-08T06:13:59.000+00:00",
            "started_at": "2024-05-08T06:13:47.000+00:00",
            "status_stats": {
                "passed": 3,
                "failed": 15,
                "pending": 0,
                "skipped": 0,
                "unknown": 0
            },
            "build_number": 243,
            "is_archived": false,
            "observability_url": "https://observability.browserstack.com/projects/Test+Observability+Samples/builds/junit-valid+xml/243"
        },
        {
            "name": "cucumber-junit-small xml",
            "status": "failed",
            "duration": 0,
            "user": "AKIIII",
            "tags": [
                "p1",
                "p2"
            ],
            "build_id": "4e0h94lmnsg0n7hqgsx5xe1rldgmaql6st8dgxzb",
            "original_name": "cucumber-k6-junit-small xml",
            "finished_at": "2024-05-08T11:42:47.036+00:00",
            "started_at": "2024-05-08T11:42:47.036+00:00",
            "status_stats": {
                "passed": 1,
                "failed": 1,
                "pending": 0,
                "skipped": 0,
                "unknown": 0
            },
            "build_number": 45,
            "is_archived": false,
            "observability_url": "https://observability.browserstack.com/projects/Test+Observability+Samples/builds/cucumber-junit-small+xml/45"
        },
        {
            "name": "cucumber-junit xml",
            "status": "failed",
            "duration": 0,
            "user": "AKIIII",
            "tags": [
                "p1",
                "p2"
            ],
            "build_id": "xolvga0rumjscbboy2uqgud8ymmpwyefudl0odcs",
            "original_name": "cucumber-k6-junit xml",
            "finished_at": "2024-05-08T11:41:46.285+00:00",
            "started_at": "2024-05-08T11:41:46.285+00:00",
            "status_stats": {
                "passed": 11,
                "failed": 2,
                "pending": 0,
                "skipped": 0,
                "unknown": 0
            },
            "build_number": 248,
            "is_archived": false,
            "observability_url": "https://observability.browserstack.com/projects/Test+Observability+Samples/builds/cucumber-junit+xml/248"
        }
    ],
    "pagination": {
        "has_next": true,
        "next_page": "eyJvZmZzZXQiOiJ4b2x2Z2EwcnVtanNjYmJveTJ1cWd1ZDh5bW1wd3llZnVkbDBvZGNzIn0="
    }
}

id Integer

Project id
name String

Name of the project
builds JSON Object

This list has information about specific builds.

▶ SHOW VALUES
- name String
  
  The name of the build. This is the derived build name after removing any dynamic parts from the name passed by you.
- status String
  
  Status of the build run. Possible values are “passed”, “failed”, “unknown”, “skipped”, “running”.
- duration Integer
  
  Run duration of the build
- user String
  
  Identifier for the user who created the build.
- tags Array
  
  Build tags associated with the build
- build_id String
  
  Unique id of the build run. Also referred to as build uuid in some places.
- original_name String
  
  Exact name of the build as passed at the time of ingestion by client. This includes the dynamic parts like build serial numbers as well.
- finished_at String
  
  Timestamp of when the build completed
- started_at String
  
  Timestamp of when the build started
- status_stats Object
  
  Status-wise breakdown of the tests runs.
  
  ▶ SHOW VALUES
  - passed Integer
    
    Number of test executions in passed status
  - failed Integer
    
    Number of test executions in failed status
  - pending Integer
    
    Number of test executions in pending status
  - skipped Integer
    
    Number of test executions in skipped status
  - unknown Integer
    
    Number of test executions in unknown status
- build_number Integer
  
  Serial number of the run for a given build, generated by Test Observability.
- is_archived Boolean
  
  Specifies if the build was archived or not.
- observability_url String
  
  URL to the build run in Test Observability
pagination JSON Object

Specifies if there is a next page and provides the value for next page.

▶ SHOW VALUES
- has_next Boolean
  
  True if there is a next page. False if there is no next page.
- next_page String
  
  A reference to the next page. Pass this as a request parameter in the subsequent request as “next_page” to get the next page of records.

get build details

Use this API to get details of a specific build-run. This API returns a high-level summary of the build run along with smart tags, failure categories, build run metadata, etc.

GET https://api-observability.browserstack.com/ext/v1/builds/{build_id}

Request parameters

Request

curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
https://api-observability.browserstack.com/ext/v1/builds/81yobvicuiuozd1bncaeegvubey7rbl8naevwets

No parameter required.

Response Attributes `200 OK` `JSON`

Response

{
    "name": "wdio-cucumber-samples",
    "description": null,
    "status": "failed",
    "duration": 254005,
    "user": "AKIIII",
    "tags": [
        "perf",
        "wdio"
    ],
    "alerts": [
        {
            "alert": "Build duration above 10 secs",
            "level": "CRITICAL"
        }
    ],
    "build_id": "81yobvicuiuozd1bncaeegvubey7rbl8naevwets",
    "build_number": 235,
    "original_name": "wdio-cucumber-samples",
    "finished_at": "2024-05-08T12:49:48.656+00:00",
    "started_at": "2024-05-08T12:45:34.651+00:00",
    "status_stats": {
        "passed": 30,
        "failed": 24,
        "pending": 0,
        "skipped": 8,
        "unknown": 0
    },
    "failure_categories": {
        "To be Investigated": 24,
        "Automation Bug": 0,
        "Product Bug": 0,
        "No Defect": 0,
        "Environment Issue": 0
    },
    "smart_tags": {
        "is_flaky": 6,
        "is_always_failing": 5,
        "is_performance_anomaly": 0,
        "is_new_failure": 1
    },
    "unique_errors": {
        "overview": {
            "insight": "96% failures caused by 3 unique errors",
            "count": 4
        },
        "top_unique_errors": [
            {
                "error": "AssertionError: assert.fail()\n    at World.<anonymous> (C:\\ProgramData\\Jenkins\\.jenkins\\workspace\\staging-sanity\\wdio-cucumber\\test-samples\\nodejs\\wdio\\stepdefinitions\/CommonSteps.js:33:16)",
                "impacted_tests": 9
            },
            {
                "error": "Error: function timed out, ensure the promise resolves within 10000 milliseconds\n    at Timeout.<anonymous> (C:\\ProgramData\\Jenkins\\.jenkins\\workspace\\staging-sanity\\wdio-cucumber\\test-samples\\nodejs\\wdio\\node_modules\\@cucumber\\cucumber\\src\\time.ts:52:14)\n    at listOnTimeout (node:internal/timers:557:17)\n    at processTimers (node:internal/timers:500:7)",
                "impacted_tests": 7
            },
            {
                "error": "AssertionError: assert.fail()\n    at C:\\ProgramData\\Jenkins\\.jenkins\\workspace\\staging-sanity\\wdio-cucumber\\test-samples\\nodejs\\wdio\\hooks\\support\/hooks.js:12:14\n    at wrapPromiseWithTimeout (C:\\ProgramData\\Jenkins\\.jenkins\\workspace\\staging-sanity\\wdio-cucumber\\test-samples\\nodejs\\wdio\\node_modules\\@cucumber\\cucumber\\src\\time.ts:55:10)\n    at Object.run (C:\\ProgramData\\Jenkins\\.jenkins\\workspace\\staging-sanity\\wdio-cucumber\\test-samples\\nodejs\\wdio\\node_modules\\@cucumber\\cucumber\\src\\user_code_runner.ts:86:16)\n    at Runtime.runTestRunHooks (C:\\ProgramData\\Jenkins\\.jenkins\\workspace\\staging-sanity\\wdio-cucumber\\test-samples\\nodejs\\wdio\\node_modules\\@cucumber\\cucumber\\src\\runtime\\run_test_run_hooks.ts:21:29)\n    at Runtime.start (C:\\ProgramData\\Jenkins\\.jenkins\\workspace\\staging-sanity\\wdio-cucumber\\test-samples\\nodejs\\wdio\\node_modules\\@cucumber\\cucumber\\src\\runtime\\index.ts:103:5)\n    at runCucumber (C:\\ProgramData\\Jenkins\\.jenkins\\workspace\\staging-sanity\\wdio-cucumber\\test-samples\\nodejs\\wdio\\node_modules\\@cucumber\\cucumber\\src\\api\\run_cucumber.ts:125:19)",
                "impacted_tests": 7
            },
            {
                "error": "Error: Can't call setValue on element with selector \"#username input\" because element wasn't found\n    at implicitWait (file:///C:/ProgramData/Jenkins/.jenkins/workspace/staging-sanity/wdio-cucumber/test-samples/nodejs/wdio/node_modules/webdriverio/build/utils/implicitWait.js:29:19)\n    at Element.elementErrorHandlerCallbackFn (file:///C:/ProgramData/Jenkins/.jenkins/workspace/staging-sanity/wdio-cucumber/test-samples/nodejs/wdio/node_modules/webdriverio/build/middlewares.js:15:29)\n    at Element.wrapCommandFn (file:///C:/ProgramData/Jenkins/.jenkins/workspace/staging-sanity/wdio-cucumber/test-samples/nodejs/wdio/node_modules/@wdio/utils/build/shim.js:90:29)\n    at SignInAppErrorPage.login (C:\\ProgramData\\Jenkins\\.jenkins\\workspace\\staging-sanity\\wdio-cucumber\\test-samples\\nodejs\\wdio\\pageobjects\\bstack-demo\/signIn.app.error.page.js:29:9)",
                "impacted_tests": 1
            }
        ]
    },
    "re_run": null,
    "build_error": null,
    "is_archived": false,
    "observability_version": {
        "framework_version": null,
        "framework_name": "WebdriverIO-cucumber",
        "sdk_version": "8.36.1"
    },
    "vcs_info": {
        "name": "git",
        "sha": "695155b136e6a6d6db50a4318ff4a39da843f418",
        "branch": null,
        "remotes": [
            {
                "url": "https://github.com/browserstack/test-observability-samples",
                "name": "origin"
            }
        ],
        "url": "https://github.com/browserstack/test-observability-samples/commit/695155b136e6a6d6db50a4318ff4a39da843f418"
    },
    "ci_info": {
        "job_name": "staging-sanity/wdio-cucumber",
        "name": "Jenkins",
        "build_number": "4165",
        "build_url": "http://localhost:8080/job/staging-sanity/job/wdio-cucumber/4165/",
        "url": null
    },
    "host_info": {
        "hostname": "EC2AMAZ-658H8P8",
        "os": null
    },
    "run_information": [
        {
            "passed": 30,
            "failed": 24,
            "id": "10037842",
            "skipped": 8,
            "unknown": 0
        }
    ],
    "observability_url": "https://observability.browserstack.com/projects/Test+Observability+Samples/builds/wdio-cucumber-samples/235"
}

name String

The name of the build. This is the derived build name of the after removing the dynamic parts from the name passed by you.
status String

Status of the build run. Possible values are “passed”, “failed”, “unknown”, “skipped”, and “running”
duration Integer

Run duration of the build.
user String

User name of the person who initiated the build.
tags Array

An array of all the tags associated with the build.
Show 18 more
alerts Array

A list of all alerts triggered for the build run with alert name and level.
build_id String

Unique ID of the build run. Also referred to as build uuid in some places.
build_number Integer

Serial number of the run for a given build, generated by Test Observability
original_name String

Exact name of the build as passed at the time of ingestion by client. This includes the dynamic parts like build serial numbers as well.
finished_at String

Timestamp of when the build completed
started_at String

Timestamp of when the build started
status_stats Object

Status-wise breakdown of the tests runs.

▶ SHOW VALUES
- passed Integer
  
  Number of test executions in passed status.
- failed Integer
  
  Number of test executions in failed status.
- pending Integer
  
  Number of test executions in pending status.
- skipped Integer
  
  Number of test executions in skipped status.
- unknown Integer
  
  Number of test executions in unknown status.
failure_categories Object

An object with the list of all the categories and the number of tests in each of these statuses.
smart_tags Object

An object with the list of all the smart tags and the number of tests associated with each of the smart tags.
unique_errors Array

An object with a list of top_unique_errors (error description and the number of of impacted tests) and an overview (total number of unique errors, with a short insight description).
build_error String

Any errors encountered during the build run.
is_archived Boolean

Specifies if the build run was archived or not.
observability_version Object

Version details of the BrowserStack SDK used, and the test framework details.
vcs_info Object

Version control information of the first run including the version controlling tool, sha value, branch name, url, and remote values.
ci_info Object

Details of the CI tool used to trigger the build for the first run.
host_info Object

Information about the host machine and the OS.
run_information Object

Details of any re-runs of the build run along with re-run summary.
observability_url String

URL to the build run on Test Observability.

get latest build details

Use this API to get details of the latest build run from a given project & build, and filter by additional parameters if needed. This API returns a high-level summary of the build run along with smart tags, failure categories, build run metadata, etc.

GET https://api-observability.browserstack.com/ext/v1/builds/latest?{params}

Request parameters

Request

curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
https://api-observability.browserstack.com/ext/v1/builds/latest?build_name=wdio-mocha-samples&project_name=Sanity%20Test%20Samples%20-%20Akhil&user_name=akhil123&build_tags=perf, wdio&framework=WebdriverIO

build_name^* String

Specify the unique build name you want to retrieve the latest build runs for.
project_name^* String

Specify the project from which you want to retrieve latest build runs for.
user_name String

Filter the search by username. You can find your username from your account settings.
build_tags String

Filter the search by any custom tags that you mapped to your builds.
framework String

Filter builds by frameworks. Allowed values are “WebdriverIO”, “TestNG”, “Mocha”, “Nightwatch”, “Cypress”, “Playwright”, “JUnit5”, “Robot”, “Pytest”, “NUnit”, “Jest”, “Serenity”, “MSTest”, “CodeceptJS”

Response Attributes `200 OK` `JSON`

Response

{
    "name": "wdio-cucumber-samples",
    "description": null,
    "status": "failed",
    "duration": 254005,
    "user": "AKIIII",
    "tags": [
        "perf",
        "wdio"
    ],
    "alerts": [
        {
            "alert": "Build duration above 10 secs",
            "level": "CRITICAL"
        }
    ],
    "build_id": "81yobvicuiuozd1bncaeegvubey7rbl8naevwets",
    "build_number": 235,
    "original_name": "wdio-cucumber-samples",
    "finished_at": "2024-05-08T12:49:48.656+00:00",
    "started_at": "2024-05-08T12:45:34.651+00:00",
    "status_stats": {
        "passed": 30,
        "failed": 24,
        "pending": 0,
        "skipped": 8,
        "unknown": 0
    },
    "failure_categories": {
        "To be Investigated": 24,
        "Automation Bug": 0,
        "Product Bug": 0,
        "No Defect": 0,
        "Environment Issue": 0
    },
    "smart_tags": {
        "is_flaky": 6,
        "is_always_failing": 5,
        "is_performance_anomaly": 0,
        "is_new_failure": 1
    },
    "unique_errors": {
        "overview": {
            "insight": "96% failures caused by 3 unique errors",
            "count": 4
        },
        "top_unique_errors": [
            {
                "error": "AssertionError: assert.fail()\n    at World.<anonymous> (C:\\ProgramData\\Jenkins\\.jenkins\\workspace\\staging-sanity\\wdio-cucumber\\test-samples\\nodejs\\wdio\\stepdefinitions\/CommonSteps.js:33:16)",
                "impacted_tests": 9
            },
            {
                "error": "Error: function timed out, ensure the promise resolves within 10000 milliseconds\n    at Timeout.<anonymous> (C:\\ProgramData\\Jenkins\\.jenkins\\workspace\\staging-sanity\\wdio-cucumber\\test-samples\\nodejs\\wdio\\node_modules\\@cucumber\\cucumber\\src\\time.ts:52:14)\n    at listOnTimeout (node:internal/timers:557:17)\n    at processTimers (node:internal/timers:500:7)",
                "impacted_tests": 7
            },
            {
                "error": "AssertionError: assert.fail()\n    at C:\\ProgramData\\Jenkins\\.jenkins\\workspace\\staging-sanity\\wdio-cucumber\\test-samples\\nodejs\\wdio\\hooks\\support\/hooks.js:12:14\n    at wrapPromiseWithTimeout (C:\\ProgramData\\Jenkins\\.jenkins\\workspace\\staging-sanity\\wdio-cucumber\\test-samples\\nodejs\\wdio\\node_modules\\@cucumber\\cucumber\\src\\time.ts:55:10)\n    at Object.run (C:\\ProgramData\\Jenkins\\.jenkins\\workspace\\staging-sanity\\wdio-cucumber\\test-samples\\nodejs\\wdio\\node_modules\\@cucumber\\cucumber\\src\\user_code_runner.ts:86:16)\n    at Runtime.runTestRunHooks (C:\\ProgramData\\Jenkins\\.jenkins\\workspace\\staging-sanity\\wdio-cucumber\\test-samples\\nodejs\\wdio\\node_modules\\@cucumber\\cucumber\\src\\runtime\\run_test_run_hooks.ts:21:29)\n    at Runtime.start (C:\\ProgramData\\Jenkins\\.jenkins\\workspace\\staging-sanity\\wdio-cucumber\\test-samples\\nodejs\\wdio\\node_modules\\@cucumber\\cucumber\\src\\runtime\\index.ts:103:5)\n    at runCucumber (C:\\ProgramData\\Jenkins\\.jenkins\\workspace\\staging-sanity\\wdio-cucumber\\test-samples\\nodejs\\wdio\\node_modules\\@cucumber\\cucumber\\src\\api\\run_cucumber.ts:125:19)",
                "impacted_tests": 7
            },
            {
                "error": "Error: Can't call setValue on element with selector \"#username input\" because element wasn't found\n    at implicitWait (file:///C:/ProgramData/Jenkins/.jenkins/workspace/staging-sanity/wdio-cucumber/test-samples/nodejs/wdio/node_modules/webdriverio/build/utils/implicitWait.js:29:19)\n    at Element.elementErrorHandlerCallbackFn (file:///C:/ProgramData/Jenkins/.jenkins/workspace/staging-sanity/wdio-cucumber/test-samples/nodejs/wdio/node_modules/webdriverio/build/middlewares.js:15:29)\n    at Element.wrapCommandFn (file:///C:/ProgramData/Jenkins/.jenkins/workspace/staging-sanity/wdio-cucumber/test-samples/nodejs/wdio/node_modules/@wdio/utils/build/shim.js:90:29)\n    at SignInAppErrorPage.login (C:\\ProgramData\\Jenkins\\.jenkins\\workspace\\staging-sanity\\wdio-cucumber\\test-samples\\nodejs\\wdio\\pageobjects\\bstack-demo\/signIn.app.error.page.js:29:9)",
                "impacted_tests": 1
            }
        ]
    },
    "re_run": null,
    "build_error": null,
    "is_archived": false,
    "observability_version": {
        "framework_version": null,
        "framework_name": "WebdriverIO-cucumber",
        "sdk_version": "8.36.1"
    },
    "vcs_info": {
        "name": "git",
        "sha": "695155b136e6a6d6db50a4318ff4a39da843f418",
        "branch": null,
        "remotes": [
            {
                "url": "https://github.com/browserstack/test-observability-samples",
                "name": "origin"
            }
        ],
        "url": "https://github.com/browserstack/test-observability-samples/commit/695155b136e6a6d6db50a4318ff4a39da843f418"
    },
    "ci_info": {
        "job_name": "staging-sanity/wdio-cucumber",
        "name": "Jenkins",
        "build_number": "4165",
        "build_url": "http://localhost:8080/job/staging-sanity/job/wdio-cucumber/4165/",
        "url": null
    },
    "host_info": {
        "hostname": "EC2AMAZ-658H8P8",
        "os": null
    },
    "run_information": [
        {
            "passed": 30,
            "failed": 24,
            "id": "10037842",
            "skipped": 8,
            "unknown": 0
        }
    ],
    "observability_url": "https://observability.browserstack.com/projects/Test+Observability+Samples/builds/wdio-cucumber-samples/235"
}

name String

The name of the build. This is the derived build name after removing the dynamic parts from the name passed by you.
status String

Status of the build run. Possible values are “passed”, “failed”, “unknown”, “skipped”, and “running”
duration Integer

Run duration of the build.
user String

User name of the person who initiated the build.
tags Array

An array of all the tags associated with the build.
Show 18 more
alerts Array

A list of all alerts triggered for the build run with alert name and level.
build_id String

Unique ID of the build run. Also referred to as build uuid in some places.
build_number Integer

Serial number of the run for a given build, generated by Test Observability
original_name String

Exact name of the build as passed at the time of ingestion by client. This includes the dynamic parts like build serial numbers as well.
finished_at String

Timestamp of when the build completed
started_at String

Timestamp of when the build started
status_stats Object

Status-wise breakdown of the test runs.

▶ SHOW VALUES
- passed Integer
  
  Number of test executions in passed status.
- failed Integer
  
  Number of test executions in failed status.
- pending Integer
  
  Number of test executions in pending status.
- skipped Integer
  
  Number of test executions in skipped status.
- unknown Integer
  
  Number of test executions in unknown status.
failure_categories Object

An object with the list of all the categories and the number of tests in each of these statuses.
smart_tags Object

An object with the list of all the smart tags and the number of tests associated with each of the smart tags.
unique_errors Array

An object with a list of top_unique_errors (error description and the number of impacted tests) and an overview (total number of unique errors, with a short insight description).
build_error String

Any errors encountered during the build run.
is_archived Boolean

Specifies if the build run was archived or not.
observability_version Object

Version details of the BrowserStack SDK used, and the test framework details.
vcs_info Object

Version control information of the first run including the version controlling tool, sha value, branch name, url, and remote values.
ci_info Object

Details of the CI tool used to trigger the build for the first run.
host_info Object

Information about the host machine and the OS.
run_information Object

Details of any re-runs of the build run along with re-run summary.
observability_url String

URL to the build run on Test Observability.

update build metadata

Use this API to add more build tags to build runs that are already completed.

PATCH https://api-observability.browserstack.com/ext/v1/builds/{build_id}

Request parameters

No request parameters.

Request

curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" -X PATCH -H "Content-Type: application/json" \
 https://api-observability.browserstack.com/ext/v1/builds/81yobvicuiuozd1bncaeegvubey7rbl8naevwets \
--header 'Content-Type: application/json' \
--data '{
   "build_tags": ["tag1", "tag2"]
}'

Response Attributes `200 OK` `JSON`

Response

{
    "success": true,
    "message": "Build updated successfully"
}

success Boolean

Returns true if the build was updated. Returns false if the build wasn’t updated.
message String

A success message or error message depending on whether the build was updated.

Did this page help you?

We're sorry to hear that. Please share your feedback so we can do better

Contact our Support team for immediate help while we work on improving our docs.

We're continuously improving our docs. We'd love to know what you liked

This page has exactly what I am looking for
This content & code samples are accurate and up-to-date
The content on this page is easy to understand
Other (please tell us more below)

Any additional feedback?

Thank you for your valuable feedback

APIs related to Builds in Test Observability

get build list

Request parameters

unique_build_names String

build_tags String

build_status String

users String

frameworks String

is_archived Boolean

date_range String

next_page String

Response Attributes 200 OK JSON

id Integer

name String

builds JSON Object

name String

status String

duration Integer

user String

tags Array

build_id String

original_name String

finished_at String

started_at String

status_stats Object

passed Integer

failed Integer

pending Integer

skipped Integer

unknown Integer

build_number Integer

is_archived Boolean

observability_url String

pagination JSON Object

has_next Boolean

next_page String

get build details

Request parameters

Response Attributes 200 OK JSON

name String

status String

duration Integer

user String

tags Array

alerts Array

build_id String

build_number Integer

original_name String

finished_at String

started_at String

status_stats Object

passed Integer

failed Integer

pending Integer

skipped Integer

unknown Integer

failure_categories Object

smart_tags Object

unique_errors Array

build_error String

is_archived Boolean

observability_version Object

vcs_info Object

ci_info Object

host_info Object

run_information Object

observability_url String

get latest build details

Request parameters

build_name* String

project_name* String

user_name String

build_tags String

framework String

Response Attributes 200 OK JSON

name String

status String

duration Integer

user String

tags Array

Response Attributes `200 OK` `JSON`

Response Attributes `200 OK` `JSON`

build_name^* String

project_name^* String

Response Attributes `200 OK` `JSON`

Response Attributes `200 OK` `JSON`