API Reference

LoadEng backend provides scenario management, test execution, and real-time metrics through REST APIs and real-time metric updates. This page is a high-level summary; full endpoint lists, parameters, and sample calls are documented in LoadEng project documentation.

REST API

The API is used for scenario CRUD, test start/stop, and result queries. Access is typically protected with authentication (API key or token); base URL and headers are defined in your deployment-specific LoadEng setup docs.

• Scenario: Create (POST), list (GET), update (PUT/PATCH), and delete (DELETE) scenarios. Each scenario includes task lists and load parameters.
• Test: Endpoints for starting/stopping tests, checking run status, and fetching summaries/reports for specific scenarios.
• Check: Availability and response-time validation for one or multiple URLs with HTTP methods (GET, POST, etc.). The site-level Uptime Check page uses Check; rate limits may apply.
• Discovery: Collected request list and Web Vitals (LCP, CLS, INP, TBT) during page load for a single URL. A dedicated endpoint is used for Playwright-based page analysis.

Real-time metric updates

During active tests, real-time metrics (RPS, latency, error rate) are updated continuously. LoadEng UI uses these updates to refresh charts and tables live. You can also monitor tests from CI/CD or custom dashboards; data format details are documented in project-level docs.

Integration and usage

You can create scenarios, trigger runs, and fetch results from your own tools (scripts, pipelines, monitoring systems). Follow rate limit, authentication, and permission rules. Check and Discovery may be available with limited access on the public site; full run management and performance testing require LoadEng account/platform access.

Next steps

Workers and Deployment for traffic-generator setup. Scenarios and Tests to revisit scenario design. Uptime Check to try endpoint checks and Discovery from the browser.