Home

API Reference

Direct REST API access for custom integrations. All endpoints require authentication via API key or session token.

Authentication

Include your API key in the Authorization header:

curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://your-dashboard.com/api/executions

Get your API key from Settings → API Keys in the dashboard.

Base URL

https://your-dashboard.vercel.app/api

Replace with your actual dashboard URL.

Endpoints

GET/api/executions

List test executions with optional filters

GET/api/executions/:id

Get detailed execution including all test results and artifacts

GET/api/metrics

Dashboard metrics: pass rate, failure counts, duration averages

GET/api/trends

Time-series pass/fail data with flexible granularity (hourly, daily, weekly, monthly)

GET/api/flaky-tests

List flaky tests sorted by flakiness rate

GET/api/compare

Compare two executions to identify regressions, improvements, and performance changes

POST/api/ingest

Upload test results (used by Playwright Reporter and GitHub Action)

Rate Limits

API requests are rate limited to ensure fair usage:

  • • 100 requests/minute for read endpoints
  • • 10 requests/minute for write endpoints
  • • Rate limit headers are included in responses

Error Handling

Errors return appropriate HTTP status codes with JSON error details:

{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid or expired API key"
  }
}

Common Status Codes

  • 200 - Success
  • 400 - Bad request (invalid parameters)
  • 401 - Unauthorized (invalid API key)
  • 404 - Resource not found
  • 429 - Rate limit exceeded
  • 500 - Internal server error