Skip to main content
Fetch Build ScreenshotsFetch SmartUI build screenshots by project_id and build_id
TestMu AI
StatusCommunityBlog
Fetch Build Screenshots

Fetch SmartUI build screenshots by project_id and build_id

This API fetches all screenshots of a particular build with comparison details. Note: When both build_id and build_name are provided in the request, buildId will be given priority over buildName.

GET
/build/screenshots
Fetch SmartUI build screenshots by project_id and build_id
curl --request GET \
--url "https://api.lambdatest.com/automation/smart-ui/build/screenshots" \
--header "Authorization: Basic <encoded-value>"
{
"screenshots": [
{
"screenshot_name": "first",
"captured_image": "URL",
"baseline_image": "URL",
"compared_image": "URL",
"browser_name": "chrome",
"browser_version": "118.0",
"viewport": "1920x1080",
"os": "default",
"mismatch_percentage": 0.1,
"status": "Approved",
"approved_by": "dummy",
"captured_image_timestamp": "2023-11-10 13:47:24",
"compared_image_timestamp": "2023-11-10 13:47:29"
}
],
"build": {
"build_id": "c74f72b5-2dd9-42a4-9478-cd8174a56152",
"name": "build-1",
"baseline": false,
"build_status": "Approved"
},
"project": {
"project_id": "ed2ee7bc-d90d-4719-91a7-19636de5a590",
"name": "web-project",
"username": "dummy"
}
}

Authorizations

Authorizationstringheaderrequired

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Query Parameters

project_namestringrequired

The name of the particular project (project id can also be used)

project_idstring

Unique identifier of the project (project name can also be used)

build_namestring

Build name can also be used instead of build Id (Optional)

build_idstring

Fetches all the screenshots of a particular build

baselineboolean

Fetches the screenshots of the baseline build of the project

screenshot_namestring

Fetches details of a specific screenshot

Response

application/json

Successful operation

screenshotsobject[]
screenshots.screenshot_namestring
Example: "first"
screenshots.captured_imagestring
Example: "URL"
screenshots.baseline_imagestring
Example: "URL"
screenshots.compared_imagestring
Example: "URL"
screenshots.browser_namestring
Example: "chrome"
screenshots.browser_versionstring
Example: "118.0"
screenshots.viewportstring
Example: "1920x1080"
screenshots.osstring
Example: "default"
screenshots.mismatch_percentagenumber
Example: 0.1
screenshots.statusstring
Example: "Approved"
screenshots.approved_bystring
Example: "dummy"
screenshots.captured_image_timestampstring
Example: "2023-11-10 13:47:24"
screenshots.compared_image_timestampstring
Example: "2023-11-10 13:47:29"
buildobject
build.build_idstring
Example: "c74f72b5-2dd9-42a4-9478-cd8174a56152"
build.namestring
Example: "build-1"
build.baselineboolean
Example: false
build.build_statusstring
Example: "Approved"
projectobject
project.project_idstring
Example: "ed2ee7bc-d90d-4719-91a7-19636de5a590"
project.namestring
Example: "web-project"
project.usernamestring
Example: "dummy"
Fetch SmartUI build screenshots by project_id and build_id
curl --request GET \
--url "https://api.lambdatest.com/automation/smart-ui/build/screenshots" \
--header "Authorization: Basic <encoded-value>"
{
"screenshots": [
{
"screenshot_name": "first",
"captured_image": "URL",
"baseline_image": "URL",
"compared_image": "URL",
"browser_name": "chrome",
"browser_version": "118.0",
"viewport": "1920x1080",
"os": "default",
"mismatch_percentage": 0.1,
"status": "Approved",
"approved_by": "dummy",
"captured_image_timestamp": "2023-11-10 13:47:24",
"compared_image_timestamp": "2023-11-10 13:47:29"
}
],
"build": {
"build_id": "c74f72b5-2dd9-42a4-9478-cd8174a56152",
"name": "build-1",
"baseline": false,
"build_status": "Approved"
},
"project": {
"project_id": "ed2ee7bc-d90d-4719-91a7-19636de5a590",
"name": "web-project",
"username": "dummy"
}
}