The Apps API is in beta. Its endpoints and responses may change.
Tests and runs
A test is the saved goal. A run is one attempt at it. Creating a test is free, and running it costs credits. An app can have up to 250 tests. To run a test and read the result:- Create a test with Create test.
- Start a run with Run test. It runs against the app’s current preview unless you send a
url, and it works against the app’s test data, not its live data. - Poll Get test run until
statusis no longerpending,running, oranalyzing. - Read the verdict and the problems found with Get test run report. It returns a
404until the report is written, so wait foranalysis_statusto becompleted.
409. Cancel test run stops a run that’s still going.
Endpoints
Tests
- Create test: Add a test to the app.
- List tests: List every test in the app.
- Get test: Read one test.
Runs
- Run test: Start a run of a test.
- List test runs: List the app’s 100 most recent runs.
- Get test run: Read one run and follow its status.
- Cancel test run: Stop a run that’s still going.
- Get test run report: Read a run’s verdict, summary, and problems found.