Export a test machine report

GET/reports/environment_result/{machine_result_id}

Base URL https://app.testsigma.com/api/v1Region

Generate a report for a single test machine within a run, in XML, PDF, or Excel format.

Authenticate with your API key as a Bearer token in the Authorization header. How to authenticate →

Path parameters

machine_result_id The ID of the test machine result to export. Not shown in the UI — copy it from the Environments request in the browser's Network tab on the Run Results page.

Query parameters

`format`	Report format — xml, pdf, or xlsx. Defaults to pdf.
`screenshot`	Test step screenshots in a PDF report — ALL_TYPES, FAILED_STEPS, or NONE. PDF only.
`visualScreenshot`	Visual testing screenshots in a PDF report — ALL_TYPES, FAILED_STEPS, or NONE. PDF only.
`resolution`	Screenshot resolution in a PDF report — LOW or HIGH. PDF only.

Response attributes

`status`	Generation state — IN_PROGRESS, SUCCESS, or FAILED.
`reportId`	ID of the generated report, returned once generation succeeds.
`url`	Download endpoint for the generated report, returned once generation succeeds.

Request

curl -X GET \
  'https://app.testsigma.com/api/v1/reports/environment_result/{machine_result_id}' \
  -H 'Authorization: Bearer <API_KEY>' \
  -H 'Content-Type: application/json'

const response = await fetch('https://app.testsigma.com/api/v1/reports/environment_result/{machine_result_id}', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer <API_KEY>',
    'Content-Type': 'application/json'
  }
});
const data = await response.json();

import requests

response = requests.get(
  'https://app.testsigma.com/api/v1/reports/environment_result/{machine_result_id}',
  headers={
    'Authorization': 'Bearer <API_KEY>',
    'Content-Type': 'application/json'
  }
)
data = response.json()

Response202 Accepted

{
  "status": "IN_PROGRESS"
}

Was this page helpful?