Project stats API

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

This API is very similar to the Build stats API, except it always shows the status of the most recently uploaded build for a project, as opposed to those of a specific build.

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.

  • Project ID or name To identify the project, you will need either its unique ID or its name. This is the same build ID that you recieved from a prior call to the build upload API. The unique ID can also be found in the console URL when viewing resources within that project in your browser. For example, in this URL: https://company.mesmerhq.com/home/X/manage-testcases/Y the project ID is X. The name of the project can be found in the project selector in the console. It’s also the name of the project that you optionally specified using the build upload API. To avoid ambiguity, it’s recommended to use the project ID instead of the name.

Request protocol

Endpoint URL

<your-console-url>/api/v1/project/stats

HTTP method

POST

HTTP headers

  • X-Access-Token

REQUIRED: <your access token>

  • Origin

REQUIRED: <your console url>

  • Content-Type

REQUIRED: application/json

Request body JSON payload

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

{ "project": "<your-project-name-or-id" }

Example request using curl

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

Response payload

The response is JSON ProjectStatsResponse object containing a nested TestStats object describing the status of tests that are either currently running or completed for the most recent build uploaded for given project.

Example response payload

{
"success": true,
"data": [
{
"completed": true,
"stats": {
"running": 0,
"queued": 0,
"passed": 0,
"failed": 0,
"error": 3,
"review": 4,
"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>"
}
]
}