Build stats API

The build stats API provides information about ongoing and completed tests for a specific build, identified by its build ID. This is intended to be used in conjunction with the Build upload API.

Configuration

You will need the following items of configuration in order to call this API:

  • Console URL The URL to your Mesmer console, including both the scheme and host. (e.g. https://your-company.mesmerhq.com). This URL also hosts the API endpoint for your account.

  • Access token The security token (API key) assigned to your account. You can get this string from your Mesmer contact.

  • Build ID or name You will need to provide the build ID or name. The build ID is returned by the Build upload API in the buildId property of the JSON response. Alternately, you can provide the build name, which was optionally assigned to the upload API. To avoid ambiguity, it’s advised to use the unique build ID if possible.

Request protocol

Endpoint URL

<your-console-url>/api/v1/build/upload

HTTP method

POST

HTTP headers

  • X-Access-Token

REQUIRED: <your access token>

  • Origin

REQUIRED: <your console url>

  • Content-Type

REQUIRED: application/jsonRequest body JSON payload

A JSON object that contains either the name or the ID of the build in this form:

{ "build": "<your-build-id-or-name>" }

Example request using curl

curl \
$YOUR_CONSOLE_URL/api/v1/build/stats \
-X POST \
-H 'X-Access-Token: <your-access-token>' \
-H 'Origin: <your-console-url>' \
-H 'Content-Type: application/json' \
-d '{"build":"<your-build-id-or-name>"}'

Response payload

The response is JSON BuildStatsResponse object containing a nested TestStats object describing the status of tests that are either currently running or completed against the given build.

Example response payload

{
"success": true,
"data": [
{
"completed": true,
"stats": {
"running": 0,
"queued": 0,
"passed": 6,
"failed": 0,
"error": 0,
"review": 1,
"total": 7
},
"projectId": "<your-project-id>",
"projectName": "<your-project-name>",
"projectPackage": "<your-project-package>",
"projectType": "<your-project-type>",
"buildId": "<your-build-id>",
"buildName": "<your-build-name>",
"buildPackage": "<your-build-package>",
"buildType": "<your-build-type>",
"buildVersion": "<your-build-version>"
}
]
}