Testery Docs
Testery Docs
Testery
Features
Pricing
Release Notes
Testery Documentation
Release Notes
Get Started
Getting Started Guide
Get to Know Testery
Dashboard
Test Runs
Projects
Schedules
Environments
Alerts
Settings
Test Plans
Deployments
System Variables
Tags
Screenshots
Uploading Test Artifacts to Testery
Setting Test Execution Priority
Setting the Number of Parallel Tests
Integrate with Testery
Built-In Integrations with Testery
CI/CD Integration Guides
Testery CLI
Testery REST API
Testery REST API Resources
Framework-specific Guidance
Supported Testing Frameworks
Cypress
TestNG
How-To
Run Cypress Tests without Connecting Repository
How to Store Sensitive Data Like Username and Password For a Cypress Test
MISC
Troubleshooting Steps
Powered by GitBook

Testery REST API Resources

A description of the available Testery REST API end points.

Test Runs

get
Get Single Test Run

https://api.testery.io/test-runs/:id
Returns a single test run by id.
Request
Response
Request
Path Parameters
id
required
string
ID of the cake to get, for free of course.
Headers
Authorization
required
string
Set to "Bearer <yourApiToken>". See [[Finding Your API Token]].
Response
200: OK
Test Run successfully retrieved
{
  "id": 55676,
  "name": "...",
  "testName": null,
  "key": "ABCDABCD75349414053EB9961013126945472A93",
  "startTime": "2020-05-04 23:16:33+0000",
  "endTime": "2020-05-04 23:22:59+0000",
  "createTime": "2020-05-04 23:15:10+0000",
  "accountId": 123,
  "projectId": 123,
  "status": "PASS",
  "copies": 1,
  "passCount": 30,
  "failCount": 0,
  "ignoredCount": 0,
  "codeCoverageName": null,
  "codeCoverageVersion": null,
  "codeCoveragePercentage": null,
  "codeCoverageTotalStatements": null,
  "codeCoverageCoveredStatements": null,
  "totalTestingTime": 1036000,
  "isSchedule": null,
  "totalCount": 30,
  "gitRef": "abcd4e87d8d928a21a393b0def6ab0c0a21d35a2",
  "buildKey": "23",
  "environment": "dev",
  "statusInfo": null,
  "includeTags": [],
  "complete": true
}
404: Not Found
Test Run not found
NO CONTENT

​

get
Get List of Test Runs

https://api.testery.io/test-runs/:id
Returns a single test run by id.
Request
Response
Request
Path Parameters
id
required
string
ID of the cake to get, for free of course.
Headers
Authorization
required
string
Set to "Bearer <yourApiToken>". See [[Finding Your API Token]].
Response
200: OK
Test Run successfully retrieved
{
  "id": 55676,
  "name": "...",
  "testName": null,
  "key": "ABCDABCD75349414053EB9961013126945472A93",
  "startTime": "2020-05-04 23:16:33+0000",
  "endTime": "2020-05-04 23:22:59+0000",
  "createTime": "2020-05-04 23:15:10+0000",
  "accountId": 123,
  "projectId": 123,
  "status": "PASS",
  "copies": 1,
  "passCount": 30,
  "failCount": 0,
  "ignoredCount": 0,
  "codeCoverageName": null,
  "codeCoverageVersion": null,
  "codeCoveragePercentage": null,
  "codeCoverageTotalStatements": null,
  "codeCoverageCoveredStatements": null,
  "totalTestingTime": 1036000,
  "isSchedule": null,
  "totalCount": 30,
  "gitRef": "abcd4e87d8d928a21a393b0def6ab0c0a21d35a2",
  "buildKey": "23",
  "environment": "dev",
  "statusInfo": null,
  "includeTags": [],
  "complete": true
}
404: Not Found
Test Run not found
NO CONTENT

​

Integrate with Testery - Previous
Testery REST API
Next - Framework-specific Guidance
Supported Testing Frameworks
Last updated 9 months ago
Contents
get
Get Single Test Run
get
Get List of Test Runs