API Documentation

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

Tests

Test Results

Suites

Suite Results

Folders

Organizations

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

Webhooks

  • Test Webhook – The payload POSTed to any specified test webhook

Test Runner IP Addresses

Rate Limits

  • Rate Limits – The API access rates allowed by the system

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