WP Legends Live Panel on March 11th: The Line Between Good and Great Agencies
WP Legends Live Panel on March 11th:
REST API Endpoints — Core Resources
This is the main section of the REST API Endpoint Reference covering the core resources: Websites, Test Flows, and Test Runs. For authentication, rate limits, and general API usage, see REST API – Getting Started.
Other Endpoint Sections
- Organization & Access – Organizations, Team, Users, Tokens
- Audits, Settings & Utilities – UX Audits, Reference Data, Settings
Websites
Base path: /api/v1/websites – 19 endpoints
| Method | Path | Description | Scope |
|---|---|---|---|
GET | /api/v1/websites | List websites with pagination and filters | read:organization |
POST | /api/v1/websites | Add a website for monitoring | write:organization |
GET | /api/v1/websites/analytics | Get aggregated analytics across websites | read:organization |
GET | /api/v1/websites/availability | Check if a URL is available for monitoring | read:organization |
GET | /api/v1/websites/:id | Get website details | read:organization |
PATCH | /api/v1/websites/:id | Update website configuration | write:organization |
DELETE | /api/v1/websites/:id | Delete website and all associated data | write:organization |
GET | /api/v1/websites/:id/health | Check website health | read:organization |
GET | /api/v1/websites/:id/screenshot | Get website screenshot URL | read:organization |
GET | /api/v1/websites/:id/logs | Get activity and error logs | read:organization |
GET | /api/v1/websites/:id/forms | List available forms (WordPress only) | read:organization |
GET | /api/v1/websites/:id/settings | Get platform-specific settings | read:organization |
GET | /api/v1/websites/:id/notifications | Get notification preferences | read:organization |
PATCH | /api/v1/websites/:id/notifications | Update notification preferences | write:organization |
DELETE | /api/v1/websites/:id/notifications | Revert notifications to org defaults | write:organization |
POST | /api/v1/websites/:id/pause | Pause all scheduled tests | write:organization |
POST | /api/v1/websites/:id/resume | Resume paused tests | write:organization |
GET | /api/v1/websites/:id/notifications/emails | Get email report settings | read:organization |
PUT | /api/v1/websites/:id/notifications/emails | Update email report settings | write:organization |
DELETE | /api/v1/websites/:id/notifications/emails | Revert email reports to org defaults | write:organization |
Note: Admin-only endpoints (run-all tests) are not listed.
Test Flows
Base path: /api/v1/test-flows – 36 endpoints
| Method | Path | Description | Scope |
|---|---|---|---|
POST | /api/v1/test-flows/from-url | Create test flow from URL (end-to-end with AI step generation) | write:organization |
GET | /api/v1/test-flows | List test flows with filtering and pagination | read:organization |
POST | /api/v1/test-flows | Create a new test flow | write:organization |
GET | /api/v1/test-flows/:id | Get test flow with steps and schedule | read:organization |
PATCH | /api/v1/test-flows/:id | Update test flow settings | write:organization |
DELETE | /api/v1/test-flows/:id | Delete test flow (fails if tests running) | write:organization |
POST | /api/v1/test-flows/:id/executions | Trigger a test execution | write:organization |
GET | /api/v1/test-flows/:id/executions | List test execution history | read:organization |
GET | /api/v1/test-flows/:id/executions/:executionId | Get execution details | read:organization |
POST | /api/v1/test-flows/:id/initializations | Start test flow setup (reset/use-as-is/retry) | write:organization |
GET | /api/v1/test-flows/:id/initializations/current | Get current setup status | read:organization |
PATCH | /api/v1/test-flows/:id/initializations/current | Update setup (e.g., abort) | write:organization |
GET | /api/v1/test-flows/:id/steps | Get all test flow steps | read:organization |
PATCH | /api/v1/test-flows/:id/steps | Replace all steps | write:organization |
GET | /api/v1/test-flows/:id/schedule | Get schedule configuration | read:organization |
PATCH | /api/v1/test-flows/:id/schedule | Update schedule | write:organization |
DELETE | /api/v1/test-flows/:id/schedule | Remove automatic scheduling | write:organization |
POST | /api/v1/test-flows/:id/files | Upload a file for test execution | write:organization |
GET | /api/v1/test-flows/:id/files | List uploaded files | read:organization |
DELETE | /api/v1/test-flows/:id/files/:fileId | Delete an uploaded file | write:organization |
POST | /api/v1/test-flows/:id/ai-generate | Trigger AI-powered step generation | write:organization |
GET | /api/v1/test-flows/:id/ai-generate/status | Get AI generation progress | read:organization |
GET | /api/v1/test-flows/:id/notifications/webhooks | Get webhook notification settings | read:organization |
PUT | /api/v1/test-flows/:id/notifications/webhooks | Update webhook settings | write:organization |
DELETE | /api/v1/test-flows/:id/notifications/webhooks | Revert webhooks to org defaults | write:organization |
GET | /api/v1/test-flows/:id/notifications/emails | Get email notification settings | read:organization |
PUT | /api/v1/test-flows/:id/notifications/emails | Update email notification settings | write:organization |
DELETE | /api/v1/test-flows/:id/notifications/emails | Revert email notifications to org defaults | write:organization |
GET | /api/v1/test-flows/:id/notifications/slack | Get Slack notification settings | read:organization |
PUT | /api/v1/test-flows/:id/notifications/slack | Update Slack notification settings | write:organization |
DELETE | /api/v1/test-flows/:id/notifications/slack | Revert Slack to org defaults | write:organization |
POST | /api/v1/test-flows/:id/screenshots | Upload a reference screenshot | write:organization |
GET | /api/v1/test-flows/:id/screenshots | List screenshots | read:organization |
DELETE | /api/v1/test-flows/:id/screenshots/:screenshotId | Delete a screenshot | write:organization |
GET | /api/v1/test-flows/:id/ai-summary | Get AI analysis of failed setup | read:organization |
Note: The test-flows count includes the ai-summary endpoint (36 total, with from-url listed first).
Test Runs
Base path: /api/v1/test-runs – 20 endpoints
| Method | Path | Description | Scope |
|---|---|---|---|
GET | /api/v1/test-runs | List test runs with filtering and search | read:organization |
GET | /api/v1/test-runs/metrics | Get aggregated metrics and analytics | read:organization |
GET | /api/v1/test-runs/:id | Get test run details with all steps | read:organization |
PATCH | /api/v1/test-runs/:id | Abort a running test | write:organization |
GET | /api/v1/test-runs/:id/video | Get video recording URL | read:organization |
GET | /api/v1/test-runs/:id/har/content | Get HAR content inline (max 50MB) | read:organization |
GET | /api/v1/test-runs/:id/har | Get HAR file download URL | read:organization |
GET | /api/v1/test-runs/:id/steps/:stepId/screenshot/content | Get screenshot as base64 PNG | read:organization |
GET | /api/v1/test-runs/:id/steps/:stepId/screenshot | Get screenshot URL | read:organization |
GET | /api/v1/test-runs/:id/steps/:stepId/console-logs | Get browser console logs | read:organization |
GET | /api/v1/test-runs/:id/steps/:stepId/network-logs | Get network request logs | read:organization |
GET | /api/v1/test-runs/:id/steps/:stepId/network-logs/:logId/request | Get request body | read:organization |
GET | /api/v1/test-runs/:id/steps/:stepId/network-logs/:logId/response | Get response body URL | read:organization |
GET | /api/v1/test-runs/:id/comments | List comments on a test run | read:organization |
POST | /api/v1/test-runs/:id/comments | Add a comment | write:organization |
DELETE | /api/v1/test-runs/:id/comments/:commentId | Delete a comment (author only) | write:organization |
PATCH | /api/v1/test-runs | Bulk update test runs (max 50, e.g., bulk abort) | write:organization |
POST | /api/v1/test-runs/comparisons | Compare 2-5 test runs side by side | read:organization |
POST | /api/v1/test-runs/:id/exports | Export test run report (JSON/PDF/HTML) | read:organization |
GET | /api/v1/test-runs/:id/ai-summary | Get AI analysis of failed test | read:organization |
Related Articles
- REST API – Getting Started
- Abort Tests – Abort running tests via API