Upload Allure Reports API

This API helps users import Allure test reports into Test Observability. You can include this API in the CI workflow as a step, for a seamless integration with Test Observability.

Why use an API when you can use our CLI?: Instead of using this API to upload your Allure Reports we recommend you use our CLI tool. This provides a quicker integration and allows us to provide more features.

Note: We recommend you upload your Allure Reports only if you do not see your framework in the list of supported frameworks. This provides an easier and deeper integration and more features with Test Observability.

Preparing Allure Reports

• Prepare your Allure Reports for upload by zipping the allure-results directory.
• Ensure allure-results is at the root of the zip file, and none of the files are tampered with prior to zipping.
• To prevent errors, ensure that the allure-results directory is cleaned between different build runs.

API details

POST https://upload-observability.browserstack.com/upload

Request parameters

Request (Basic)

curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" -vvv \
    -X POST \
    -F "data=@/Users/TestUser/allure-results.zip" \
    -F "projectName=Allure Report Project" \
    -F "buildName=Allure Upload Build" \
    -F "tags=p0, p1" \
    -F "format=allure" \
    https://upload-observability.browserstack.com/upload

curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" -vvv \
    -X POST \
    -F "data=@/Users/TestUser/allure-results.zip" \
    -F "projectName=Allure Report Project" \
    -F "buildName=Allure Upload" \
    -F "tags=p0, p1" \
    -F "format=allure" \
    -F "buildIdentifier=Your Build Identifier" \
    -F "frameworkVersion=mocha, 10.0.0" \
    -F "ci=http://localhost:8080/" \
    -F 'versionControl={"name": "git","sha":"6a1f6ff49a7f10afc8332b0ac659faf0d0bf8460","short_sha":"95e576b780","tag":"null","branch":"something","committer":"GitHub <noreply@github.com>","author":"Author <92428053+Author@users.noreply.github.com>","commit_message":"downgrade zip.js","root":"/Users/TestUser/Documents/Observability/test-observability-samples","common_git_dir":"/Users/TestUser/Documents/Observability/test-observability-samples/.git","worktree_git_dir":"/Users/TestUser/Documents/Observability/test-observability-samples/.git","last_tag":"null","remotes":[{"name":"origin","url":"git@github.com:browserstack/test-observability-samples.git"},{"name":"origin","url":"git@github.com:browserstack/test-samples.git", "remote_name": "remote_destination"}]}' \
    -F 'hostInfo={"hostName": "host-001"}' \
    https://upload-observability.browserstack.com/upload

Response attributes 200 OK JSON

{
    "status": "success",
    "message": "Request to import Allure Reports received. Visit https://observability.browserstack.com/builds/egx8vyi2sytcwdonwpecyi61ogmewffarud76oes for more details."
}

Limitations

• You have to upload Allure Reports chronologically. Test Observability considers the timestamp of the first test in the allure-results folder as the build start time. If you upload a build of the same name with a test that has an earlier timestamp, Test Observability will reject the build. This is to prevent data from previous runs from corrupting test result history metrics that are critical for analysis.
• The buildIdentifier expires after six hours. Hence, new test results cannot be appended to an existing build run after six hours from the first API call.