How versatile is the Ghost Inspector API? We’re so glad you asked!
With our API, you can easily integrate Ghost Inspector into your current software testing processes and take full control over your automated testing workflow. Whether you want to execute tests, grab results, manage suites and folders, or pull historical data, the API lets you do it all without relying on the UI.
Our API offers the adaptability you need to fully automate your testing strategy, from simple test runs to complex reporting and monitoring. If you’re looking for a way to speed up your testing process while keeping everything running smoothly, Ghost Inspector’s API has you covered.
Read on for the 11 most common customer questions about our API’s capabilities and see for yourself how easy it is to integrate Ghost Inspector automation into your testing operations.
Table of Contents
- Can you use Ghost Inspector through the API alone once tests are set up?
- Can the API access test results with the same screenshots and videos show in the Ghost Inspector UI?
- Can you execute a test or suite directly through Ghost Inspector’s API?
- Can you create tests, folders, and suites using the API directly?
- Can you get additional information from the API directly about tests and suites, such as creator, creation date, last run date, and so on?
- Can you access all tests, suites, and folders in your account through the API directly?
- Can you update existing tests, suites, and folders and make changes as needed through the API directly without going through the UI?
- If there’s an active test or suite being run, can they be cancelled?
- Can you get results for a specific test or suite using the API directly?
- Can you generate a real-time status badge for a test or suite using the API?
- Can you pull the complete historical record of test and suite results using the API?
Automate your testing workflow easily with the
Ghost Inspector API
Our 14 day free trial gives you and your team full access. Create tests in minutes. No credit card required.
1. Can you use Ghost Inspector through the API alone once tests are set up?
Yes, once your tests are set up, you can run everything through the API without using Ghost Inspector’s UI. The API lets you execute tests, retrieve results (including screenshots and videos), and manage tests, suites, and settings remotely, so you can efficiently integrate Ghost Inspector into your existing workflows and automate testing end-to-end.
Step-by-Step Documentation:
2. Can the API access test results with the same screenshots and videos shown in the Ghost Inspector UI?
Yes, you can see the same test results with screenshots and video. The API provides easy access to detailed execution data, pass/fail statuses, and visual evidence of test runs. This way, you can conveniently review results, debug issues, or integrate reports into your workflow.
Step-by-Step Documentation:
3. Can you execute a test or suite directly through Ghost Inspector’s API?
Yes, simply send an HTTP request to the appropriate API endpoint, and the test or suite will execute. You can also include options like environment variables, browser settings, and webhooks to customize the run. The API response will provide details about the test execution and its results, which makes it easy to integrate with CI/CD pipelines or other automated workflows.
Step-by-Step Documentation:
4. Can you create tests, folders, and suites using the API directly?
Yes, just make the corresponding API request. You can easily define names, descriptions, and settings to customize them. The response will confirm the creation and provide relevant details, making it easy to organize and manage your tests programmatically.
Step-by-Step Documentation:
5. Can you get additional information from the API directly about tests and suites, such as creator, creation date, last run date, and so on?
Yes, the API gives you detailed test and suite info, like who created them, when they were made, and the last time they ran. This makes it easy to track test history, keep things organized, and monitor usage over time. The API response includes all the key details you’d typically see in the UI, so you can manage everything programmatically.
Step-by-Step Documentation:
6. Can you access all tests, suites, and folders in your account through the API directly?
Yes, you get full access to all tests, suites, and folders, so you can easily keep everything organized and updated via the API. You can also pull a complete list, get details, and manage them directly without needing the UI.
Step-by-Step Documentation:
- Fetch an array of all the tests in your account
- Fetch an array of all the folders in your account
- Fetch an array of all the suites in your account
7. Can you update existing tests, suites, and folders and make changes as needed through the API directly without going through the UI?
Yes, tests, suites, and folders can be updated and changed through the API. You can also modify names, settings, and other details as needed, making it easy to manage and adjust things on the fly.
Step-by-Step Documentation:
- Update a test and return updated test
- Update a folder and return updated folder
- Update a suite and return updated suite
8. If there’s an active test or suite being run, can they be cancelled?
Yes, you can cancel an active test or suite run through the API. If a test is in progress and you need to stop it, just send a request to cancel it, and it will be stopped immediately.
Step-by-Step Documentation:
9. Can you get results for a specific test or suite using the API directly?
Yes, you can pull results for a specific test or suite directly through the API. Just send a request, and you’ll get details like pass/fail status, timestamps, screenshots, and videos. This makes it easy to track performance and debug without needing the UI.
Step-by-Step Documentation:
10. Can you generate a real-time status badge for a test or suite using the API?
Yes, with the API, you can create a real-time status badge for a test or suite. You can grab a URL that updates automatically to show the latest pass/fail status, making it easy to display in dashboards, README files, or other reports.
Step-by-Step Documentation:
11. Can you pull the complete historical record of test and suite results using the API?
Yes, the all-time history of your test and suite results can be pulled through the API. Just make a request, and you’ll get all past runs, including statuses, timestamps, screenshots, and videos, so you can track performance over time.
Step-by-Step Documentation:
Conclusion
Ghost Inspector’s API offers the flexibility and accessibility to automate testing and integrate flawlessly with your tools. No matter what part of the testing process you’re working on, the API makes the whole process much easier, from triggering tests to pulling results to organizing suites and folders.
Hopefully, if you had a question about our API, you found the answer in one of these 11 popular customer questions. Or if you’re just curious about how powerful our API is, now you’ve got a handle on how to get started with our API. If you’re ready to dig deeper and start building a testing setup that works exactly how you need it to, you can start a free 14-day trial here, no credit card required.
Automate your testing workflow easily with the
Ghost Inspector API
Our 14 day free trial gives you and your team full access. Create tests in minutes. No credit card required.
