API reference
Every live operation of the Metricevo API, with its scope. Open one for its fields and to try it.
44 live operations, contract version 0.1.0-draft. The same list as JSON:/api/v1/openapi.json.
Sites
Add, read, change and remove sites.
| Method and path | What it does | Access |
|---|---|---|
GET /sites | List sites in the workspace | sites:read |
POST /sites | Add a site. The URL policy runs before anything is stored. | sites:write |
GET /sites/{siteId} | Get one site with its latest audit | sites:read |
PATCH /sites/{siteId} | Rename a site or change its recurring audit schedule | sites:write |
DELETE /sites/{siteId} | Remove a site with its runs and observations | sites:write |
GET /sites/{siteId}/report-email | Who gets the audit report of this site by email | sites:read |
PATCH /sites/{siteId}/report-email | Turn the report mail to the account's own address on or off | sites:write |
POST /sites/{siteId}/report-email/recipients | Add another recipient of the report (verified sites only) | sites:write |
DELETE /sites/{siteId}/report-email/recipients/{recipientId} | Remove a recipient | sites:write |
POST /report-emails/stop | Stop the report mails to an address (the link in the mail) | Public |
GET /sites/{siteId}/verification | Ownership state of a site, and what to publish to prove it | sites:read |
POST /sites/{siteId}/verification | Look for the DNS TXT record or the file that proves ownership | sites:write |
Audit runs
Check a URL, start audits, poll them and read the results.
| Method and path | What it does | Access |
|---|---|---|
POST /url-checks | Run the URL policy without starting an audit | audits:read |
GET /audit-runs | List audit runs, newest first | audits:read |
POST /audit-runs | Queue an audit. Returns at once; the run is asynchronous. | audits:write |
GET /audit-runs/{runId} | Get one audit run; poll this until the status is final | audits:read |
GET /audit-runs/{runId}/observations | The results of one audit run, one per check | audits:read |
Audit scopes
The built-in scopes and the scopes you save, with their credits.
| Method and path | What it does | Access |
|---|---|---|
GET /audit-scopes | Built-in and saved audit scopes | audits:read |
POST /audit-scopes | Save your own scope | audits:write |
GET /audit-scopes/{scopeId} | One saved scope | audits:read |
PATCH /audit-scopes/{scopeId} | Rename a saved scope or change its checks | audits:write |
DELETE /audit-scopes/{scopeId} | Remove a saved scope | audits:write |
Usage
Audit credits used by the account, against the plan's credits.
| Method and path | What it does | Access |
|---|---|---|
GET /usage | Audit credits used by this account | audits:read |
Automations
Automations, their activity, and the incoming webhook.
| Method and path | What it does | Access |
|---|---|---|
GET /automations | List your automations | audits:read |
POST /automations | Create an automation from a trigger and its actions | audits:write |
GET /automations/{automationId} | Get one automation with its graph and signing secret | audits:read |
PATCH /automations/{automationId} | Rename, turn on or off, or replace the graph | audits:write |
DELETE /automations/{automationId} | Remove an automation; its incoming webhook stops working | audits:write |
POST /automations/{automationId}/hook | Replace the incoming webhook address; the old one stops at once | audits:write |
GET /automations/{automationId}/events | The last 50 triggers and deliveries of an automation | audits:read |
POST /hooks/{token} | Incoming webhook. Starts the audit of the automation it belongs to | Public |
Rules
The check catalogue of the live profile.
| Method and path | What it does | Access |
|---|---|---|
GET /rules | Every check, its audit level and what it means | Public |
Keys
List, create and revoke API keys.
| Method and path | What it does | Access |
|---|---|---|
GET /api-keys | List your keys (never the secret). Human session only | App session only |
POST /api-keys | Create a key; it is shown once. Human session only | App session only |
DELETE /api-keys/{keyId} | Revoke a key. Human session only | App session only |
Billing
Plans, your usage and spend cap, checkout and the billing portal.
| Method and path | What it does | Access |
|---|---|---|
GET /plans | The plans, their prices in USD and their limits | Public |
GET /billing | Your plan, this period's usage and your spend cap | Any key |
PATCH /billing | Set the monthly spend cap (signed-in session only) | App session only |
POST /billing/checkout | Start a checkout for Starter, Pro or Ultra (session only) | App session only |
POST /billing/purchases | Buy the one-time deep audit for a site (session only) | App session only |
POST /billing/portal | Open the Stripe customer portal (session only) | App session only |
Support
Report a problem and follow it.
| Method and path | What it does | Access |
|---|---|---|
GET /problem-reports | Problems you reported, newest first | Any key |
POST /problem-reports | Report a problem to the Metricevo team | Any key |
Meta
The OpenAPI contract itself.
| Method and path | What it does | Access |
|---|---|---|
GET /openapi.json | This contract as JSON (live operations only) | Public |