Get build list API in Test Observability

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 build list

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.

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

Get build list API 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

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

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

Response Attributes `200 OK` `JSON`