API

GET /suite/{suite_id}/status

This endpoint retrieves the status of a specified suite, providing basic information about the tests run inside the suite.

Parameters

• suite_id (string, required): The unique identifier of the suite for which the status is being requested.

Response

• 200 OK: Successfully retrieved the status.

  • Content: JSON object containing:

    • suite_id (string): The ID of the suite.

    • status (string): The current status of the suite ("initial", "running", "completed", "cancelled", "queued").

    • totalRuns(number): Total number of tests run in the suite.

    • succeededTests(list): A list of JSON object containing basic information about the succeded tests

    • failedTests(list): A list of JSON object containing basic information about the failed tests

    • blockedTests(list): A list of JSON object containing basic information about the blocked tests

• 500 Internal Server Error: An error occurred on the server side.

Example Request

curl https://api.mobileboost.io/suite/a1b2c3d4f5g6h7/status

Example Response (running suite)

{
  "succeededTests": [],
  "failedTests": [],
  "blockedTests": [],
  "testSuiteId": "<suite_id>",
  "totalRuns": 1,
  "status": "running"
}

Example Response (completed suite)

{
  "succeededTests": [
    {
      "id": "<test_id>",
      "title": "Test title",
      "status": "succeeded",
      "recording": "https://app.mobileboost.io/recording/<suite_id>/runs/<run_id>"
    }
  ],
  "failedTests": [
    {
      "id": "<test_id>",
      "title": "Test title",
      "status": "failed",
      "recording": "https://app.mobileboost.io/recording/<suite_id>/runs/<run_id>"
    }
  ],
  "blockedTests": [],
  "testSuiteId": "<suite_id>",
  "totalRuns": 2,
  "status": "completed"
}