API Documentation

Our API allows you to access and run tests remotely. It can be used to integrate Ghost Inspector into your workflow.

Folders

Organizations

Get Running - Fetch a list of the currently-executing results for the entire organization

Suites

List - Fetch an array of all the suites in your account
Get - Fetch a single suite from your account
Execute - Execute all the tests in a suite and returns an array of results
Create - Create a suite and return the new suite
Update - Update a suite and return the updated suite
List Tests - Fetch an array of all the tests in a suite
List Suite Results - Fetch an array of suite results for a suite
List Suite Results in CSV Format - Fetch a CSV formatted export of suite results for a suite NEW
Download in Selenium IDE Format (.side) - Download suite in Selenium IDE format (.side)
Download in Selenium IDE Format (.html) - Download a zip file of all tests in Selenium IDE format (.html)
Download in Selenium Builder Format (.json) - Download a zip file of all tests in Selenium Builder format (.json)
Suite Status Badge - Real-time embeddable status badge for your suite

Tests

List - Fetch an array of all the tests in your account
Get - Fetch a single test from your account
Get - Update a test and return the updated test
Delete - Delete a test
Execute - Execute a single test in your account and return the result
Get Running - Fetch a list of the currently-executing results for this test
Accept Screenshot - Accept a screenshot as the new baseline for the test
Duplicate - Duplicate a single test and return the new test
List Test Results - Fetch an array of test results for a test
List Test Results in CSV Format - Fetch a CSV formatted export of test results for a test NEW
Download in Selenium IDE Format (.side) - Download a single test in Selenium IDE format (.side)
Download in Selenium IDE Format (.html) - Download a single test in Selenium IDE format (.html)
Download in Selenium Builder Format (.json) - Download a single test in Selenium Builder format (.json)
Test Status Badge - Real-time embeddable status badge for your test

Suite Results

Test Results

Errors

Authentication - The error that is returned when authentication fails
Validation - The error that is returned when the request is not valid
Timeout - The error that is returned when the request times out before completing
Server Problem - The error that is returned when the Ghost Inspector service is encountering problems

Webhooks

Our API allows you to access and run tests remotely