# Empirical

## Docs

- [Introduction](https://docs.empirical.run/api-reference/analytics/introduction.md): Retrieve aggregated test analytics and trends
- [Test Cases](https://docs.empirical.run/api-reference/analytics/test-cases.md): Returns test case analytics with metrics and history
- [Test Runs](https://docs.empirical.run/api-reference/analytics/test-runs.md): Returns test run data aggregated by day for charts
- [Cancel Test Run](https://docs.empirical.run/api-reference/cancel-test-run.md): Cancels a test run that is currently in progress or pending.
- [Create Resource](https://docs.empirical.run/api-reference/create-resource.md): Creates a resource record and returns a presigned upload URL. Upload the file via PUT to the `upload_url`, then confirm with PATCH.
- [Create Snooze](https://docs.empirical.run/api-reference/create-snooze.md): Creates a new snooze to temporarily suppress test failures for the specified Playwright tests.
- [Create Test Run](https://docs.empirical.run/api-reference/create-test-run.md): Triggers a new test run for the specified project and environment.
- [Delete Resource](https://docs.empirical.run/api-reference/delete-resource.md): Deletes a resource and removes it from storage.
- [Delete Snooze](https://docs.empirical.run/api-reference/delete-snooze.md): Permanently deletes a snooze.
- [List Environments](https://docs.empirical.run/api-reference/environments/list.md): Returns all environments for a project
- [Get Resource](https://docs.empirical.run/api-reference/get-resource.md): Returns a single resource with a signed download URL that expires in 1 hour.
- [Get Snooze](https://docs.empirical.run/api-reference/get-snooze.md): Retrieves a single snooze by its ID.
- [Get Test Case](https://docs.empirical.run/api-reference/get-test-case.md): Returns a single test case by its Playwright test ID.
- [Get Test Run](https://docs.empirical.run/api-reference/get-test-run.md): Retrieves detailed information about a specific test run, including test results and project context.
- [Get User](https://docs.empirical.run/api-reference/get-user.md): Returns a single user by their ID.
- [Skip Git Check](https://docs.empirical.run/api-reference/git-checks/skip.md): Mark a GitHub check run as skipped for a given commit
- [Google Sheets Proxy](https://docs.empirical.run/api-reference/google-sheets-proxy.md): Generic proxy endpoint for Google Sheets and Drive API requests. Authenticates with the dashboard's service account and forwards the request. Supports any Sheets or Drive API operation the service account has access to.
- [Google Sheets Proxy](https://docs.empirical.run/api-reference/google-sheets/proxy.md): Read, write, or append to a Google Sheet
- [List Artifacts](https://docs.empirical.run/api-reference/list-artifacts.md): Returns URLs to artifacts stored for a test run. You can filter by exact key, prefix, suffix, or retrieve all artifacts.
- [List Environments](https://docs.empirical.run/api-reference/list-environments.md): Returns all environments configured for a project.
- [List Resources](https://docs.empirical.run/api-reference/list-resources.md): Returns uploaded project resources with signed download URLs.
- [List Snoozes](https://docs.empirical.run/api-reference/list-snoozes.md): Returns a paginated list of snoozes for a project with optional filtering.
- [List Test Cases](https://docs.empirical.run/api-reference/list-test-cases.md): Returns test cases from the test_cases_v2 table, keyed by Playwright test ID. Supports filtering by file path, Playwright project, tags, and full-text search.
- [List Test Runs](https://docs.empirical.run/api-reference/list-test-runs.md): Retrieves a paginated list of test runs for a project with optional filtering by branch, state, result, and environment.
- [Create Resource](https://docs.empirical.run/api-reference/resources/create.md): Create a resource and get a presigned upload URL
- [Delete Resource](https://docs.empirical.run/api-reference/resources/delete.md): Delete a resource and its uploaded content
- [Get Resource](https://docs.empirical.run/api-reference/resources/get.md): Retrieve a single resource by ID
- [List Resources](https://docs.empirical.run/api-reference/resources/list.md): Retrieve a paginated list of resources for a project
- [Update Resource](https://docs.empirical.run/api-reference/resources/update.md): Update a resource name, description, or confirm upload
- [Skip Git Check](https://docs.empirical.run/api-reference/skip-git-check.md): Marks a GitHub check run as skipped for the specified repository and commit. Useful when a commit does not require a test run.
- [Create Snooze](https://docs.empirical.run/api-reference/snoozes/create.md): Create a new snooze for one or more tests
- [Delete Snooze](https://docs.empirical.run/api-reference/snoozes/delete.md): Delete a snooze
- [Get Snooze](https://docs.empirical.run/api-reference/snoozes/get.md): Retrieve a snooze by ID
- [List Snoozes](https://docs.empirical.run/api-reference/snoozes/list.md): Retrieve a paginated list of snoozes for a project
- [Update Snooze](https://docs.empirical.run/api-reference/snoozes/update.md): Update an existing snooze
- [Test Cases Analytics](https://docs.empirical.run/api-reference/test-cases-analytics.md): Returns test case analytics with aggregated metrics and run history. Supports filtering, searching, and sorting.
- [Get Test Case](https://docs.empirical.run/api-reference/test-cases/get.md): Returns a single test case by its Playwright test ID
- [List Test Cases](https://docs.empirical.run/api-reference/test-cases/list.md): Returns test cases for a project with optional filters
- [Update Test Case Tags](https://docs.empirical.run/api-reference/test-cases/update-tags.md): Update tags for a test case in the database and source file
- [Test Runs Analytics](https://docs.empirical.run/api-reference/test-runs-analytics.md): Returns test run statistics aggregated by day, including run counts, pass/fail breakdown, and test-level metrics.
- [List Artifacts](https://docs.empirical.run/api-reference/test-runs/artifacts.md): List artifacts for a test run with optional filtering by key, prefix, or suffix
- [Cancel Test Run](https://docs.empirical.run/api-reference/test-runs/cancel.md): Cancel a running or pending test run
- [Create Test Run](https://docs.empirical.run/api-reference/test-runs/create.md): Trigger a new test run
- [Get Test Run](https://docs.empirical.run/api-reference/test-runs/get.md): Retrieve details of a specific test run
- [Introduction](https://docs.empirical.run/api-reference/test-runs/introduction.md): Trigger, list, and manage test runs
- [List Test Runs](https://docs.empirical.run/api-reference/test-runs/list.md): Retrieve a paginated list of test runs with filtering options
- [Update Resource](https://docs.empirical.run/api-reference/update-resource.md): Update a resource name, description, or confirm upload by setting status to "uploaded".
- [Update Snooze](https://docs.empirical.run/api-reference/update-snooze.md): Updates an existing snooze. Use to extend, expire, or modify a snooze.
- [Update Test Case Tags](https://docs.empirical.run/api-reference/update-test-case-tags.md): Updates the tags for a given test case. This updates both the database record and the Playwright test source file on GitHub.
- [Get User](https://docs.empirical.run/api-reference/users/get.md): Returns a single user by their ID
- [Get started](https://docs.empirical.run/cli/get-started.md): Start using the CLI
- [Record a test](https://docs.empirical.run/cli/record.md): Record a test with the CLI
- [Analytics](https://docs.empirical.run/features/analytics.md): Track test health and performance over time
- [Branching](https://docs.empirical.run/features/branching.md): Align tests changes with new feature and environments
- [Code Coverage](https://docs.empirical.run/features/code-coverage.md): Measure code coverage for your test runs
- [Concurrency Limits](https://docs.empirical.run/features/concurrency-limits.md): Control how concurrent test runs are handled within a project
- [Email Testing](https://docs.empirical.run/features/email-testing.md): Test email workflows like OTPs, invitations, and notifications
- [Slack Notifications](https://docs.empirical.run/features/slack-notifications.md): Tag test owners in Slack when tests fail
- [Webhook Testing](https://docs.empirical.run/features/webhook-testing.md): Assert that your application sends the correct webhooks
- [Introduction](https://docs.empirical.run/index.md): Welcome to Empirical docs
- [GitHub Reporter](https://docs.empirical.run/integrations/github.md): Install and configure our GitHub Reporter app
- [Jira](https://docs.empirical.run/integrations/jira.md): Create coverage requests from Jira tickets
- [Linear](https://docs.empirical.run/integrations/linear.md): Create coverage requests from Linear issues
- [Slack](https://docs.empirical.run/integrations/slack.md): Install and configure our Slack app
- [App Knowledge](https://docs.empirical.run/platform/app-knowledge.md): Document your product to guide test generation agents
- [Environments](https://docs.empirical.run/platform/environments.md): Run your tests across different deployments
- [Issues](https://docs.empirical.run/platform/issues.md): Investigate and resolve test failures
- [Repository](https://docs.empirical.run/platform/repository.md): Your test code repository on GitHub
- [Requests](https://docs.empirical.run/platform/requests.md): Ask our agents to write new tests
- [Snoozes](https://docs.empirical.run/platform/snoozes.md): Suppress known failures while you work on a fix
- [Test Run Configuration](https://docs.empirical.run/platform/test-run-configuration.md): Configure regions, shards, and notifications for your test runs
- [Ad-hoc runs](https://docs.empirical.run/triggers/ad-hoc.md): Trigger a test run once via Dashboard or Slack
- [From CI/CD pipelines](https://docs.empirical.run/triggers/ci-cd.md): Run tests after production or pre-prod deployments
- [Scheduled runs](https://docs.empirical.run/triggers/scheduled.md): Run tests on schedule

## OpenAPI Specs

- [openapi](https://docs.empirical.run/api-reference/openapi.json)