API Documentation

Our API allows you to access and run tests remotely

Search our documentation:

Toggle Documentation Menu

API Documentation

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

Suites
Tests
Suite Results
  • Get - Fetch a single suite result
  • List Test Results - Fetch an array of test results for a suite result
Test Results
  • Get - Fetch a single test result
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
  • Test Webhook - The payload POSTed to any specified test webhook