Tesults API Targets

If you are just getting started with Tesults and have not submitted test results data to Tesults yet and cannot see any results data in the results view, read the integration documentation instead. Once that has been completed, you can use the Tesults API to retrieve results data to make decisions within your continuous integration and deployment pipelines.

Targets

Fetch targets belonging to a project.

Requesting targets data is useful for getting the id and names of all of the targets that belong to a project. When fetching results the id of the target to fetch results for is required.

Endpoint

https://www.tesults.com/api/targets
GET Method

Headers

The Authorization header is required for all requests to the Tesults API. See the authentication documentation for details.

Name
Authorization
Value
Bearer <token>

Parameters

Total: 2
NameValue
limit (optional)A number (minimum value 1) to limit the number of targets returned. If no limit is supplied the default limit is 100.
cursor (optional)Pagination parameter. If a cursor is returned in the response data from a request that means more data is available. Add the value of the cursor returned in the response in the next request to retrieve the next set of data.

Response

Successful response:

{
  "data": {
    "code": 200,
    "message": "Success",
    "targets": [
      {
        "id": <id>,
        "name": <name>,
        ...
      }
    ],
    "cursor": <cursor>
  }
}

Failure response:

{
  "error": {
    "code": 401,
    "message": "Unauthorized",
  }
}

Successful responses return JSON containing a data property. Error responses return JSON containing an error property. Both data and error values contain a code and message property, specifying the http status code and a message containing additional context.

Successful responses also contain additional properties within data. The response includes an array of targets and cursor for pagination use if there is additional data available (more targets) to retrieve.