Type at least two letters.

    ↑ ↓ to moveEnter to open

    API reference

    Every live operation of the Metricevo API, with its scope. Open one for its fields and to try it.

    Updated

    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 pathWhat it doesAccess
    GET /sitesList sites in the workspacesites:read
    POST /sitesAdd a site. The URL policy runs before anything is stored.sites:write
    GET /sites/{siteId}Get one site with its latest auditsites:read
    PATCH /sites/{siteId}Rename a site or change its recurring audit schedulesites:write
    DELETE /sites/{siteId}Remove a site with its runs and observationssites:write
    GET /sites/{siteId}/report-emailWho gets the audit report of this site by emailsites:read
    PATCH /sites/{siteId}/report-emailTurn the report mail to the account's own address on or offsites:write
    POST /sites/{siteId}/report-email/recipientsAdd another recipient of the report (verified sites only)sites:write
    DELETE /sites/{siteId}/report-email/recipients/{recipientId}Remove a recipientsites:write
    POST /report-emails/stopStop the report mails to an address (the link in the mail)Public
    GET /sites/{siteId}/verificationOwnership state of a site, and what to publish to prove itsites:read
    POST /sites/{siteId}/verificationLook for the DNS TXT record or the file that proves ownershipsites:write

    Audit runs

    Check a URL, start audits, poll them and read the results.

    Method and pathWhat it doesAccess
    POST /url-checksRun the URL policy without starting an auditaudits:read
    GET /audit-runsList audit runs, newest firstaudits:read
    POST /audit-runsQueue 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 finalaudits:read
    GET /audit-runs/{runId}/observationsThe results of one audit run, one per checkaudits:read

    Audit scopes

    The built-in scopes and the scopes you save, with their credits.

    Method and pathWhat it doesAccess
    GET /audit-scopesBuilt-in and saved audit scopesaudits:read
    POST /audit-scopesSave your own scopeaudits:write
    GET /audit-scopes/{scopeId}One saved scopeaudits:read
    PATCH /audit-scopes/{scopeId}Rename a saved scope or change its checksaudits:write
    DELETE /audit-scopes/{scopeId}Remove a saved scopeaudits:write

    Usage

    Audit credits used by the account, against the plan's credits.

    Method and pathWhat it doesAccess
    GET /usageAudit credits used by this accountaudits:read

    Automations

    Automations, their activity, and the incoming webhook.

    Method and pathWhat it doesAccess
    GET /automationsList your automationsaudits:read
    POST /automationsCreate an automation from a trigger and its actionsaudits:write
    GET /automations/{automationId}Get one automation with its graph and signing secretaudits:read
    PATCH /automations/{automationId}Rename, turn on or off, or replace the graphaudits:write
    DELETE /automations/{automationId}Remove an automation; its incoming webhook stops workingaudits:write
    POST /automations/{automationId}/hookReplace the incoming webhook address; the old one stops at onceaudits:write
    GET /automations/{automationId}/eventsThe last 50 triggers and deliveries of an automationaudits:read
    POST /hooks/{token}Incoming webhook. Starts the audit of the automation it belongs toPublic

    Rules

    The check catalogue of the live profile.

    Method and pathWhat it doesAccess
    GET /rulesEvery check, its audit level and what it meansPublic

    Keys

    List, create and revoke API keys.

    Method and pathWhat it doesAccess
    GET /api-keysList your keys (never the secret). Human session onlyApp session only
    POST /api-keysCreate a key; it is shown once. Human session onlyApp session only
    DELETE /api-keys/{keyId}Revoke a key. Human session onlyApp session only

    Billing

    Plans, your usage and spend cap, checkout and the billing portal.

    Method and pathWhat it doesAccess
    GET /plansThe plans, their prices in USD and their limitsPublic
    GET /billingYour plan, this period's usage and your spend capAny key
    PATCH /billingSet the monthly spend cap (signed-in session only)App session only
    POST /billing/checkoutStart a checkout for Starter, Pro or Ultra (session only)App session only
    POST /billing/purchasesBuy the one-time deep audit for a site (session only)App session only
    POST /billing/portalOpen the Stripe customer portal (session only)App session only

    Support

    Report a problem and follow it.

    Method and pathWhat it doesAccess
    GET /problem-reportsProblems you reported, newest firstAny key
    POST /problem-reportsReport a problem to the Metricevo teamAny key

    Meta

    The OpenAPI contract itself.

    Method and pathWhat it doesAccess
    GET /openapi.jsonThis contract as JSON (live operations only)Public