Type at least two letters.

    ↑ ↓ to moveEnter to open

    Usage API

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

    Updated

    1 live operation. Built from the OpenAPI contract at every release, so this page never lists an endpoint that does not work. Paths are relative to the base URL.

    To try these with your own account, sign in and open Automation → Try the API in the app.

    Audit credits used by this account

    GET/api/v1/usage
    Scope: audits:readoperationId: getUsage

    Every check has a credit value (`GET /rules`). A finished audit costs the sum of its checks; an audit that could not start costs nothing. Days are UTC. No plan limit is enforced yet, so `limit` is `null`.

    Responses

    200Usage

    Usage totals

    5 fields
    limitinteger or null

    Credits included in the account's plan per billing period (Free 250, Pro 5,000). A run that would go over is refused on Free (`credit_limit_reached`) and billed as overage on a paid plan up to the spend cap.

    todayobject
    3 fields of today
    creditsinteger
    runsinteger

    Finished audits that cost credits.

    daystring (date)
    thisMonthobject
    3 fields of thisMonth
    creditsinteger
    runsinteger

    Finished audits that cost credits.

    monthstring
    monthsarray of object

    The last 90 days by month, newest first.

    3 fields of months
    creditsinteger
    runsinteger

    Finished audits that cost credits.

    monthstring
    daysarray of object

    Days with usage, newest first, at most 31.

    3 fields of days
    creditsinteger
    runsinteger

    Finished audits that cost credits.

    daystring (date)
    ErrorProblem (application/problem+json)

    RFC 9457 problem

    Try it: signed in, open this operation in the app. It runs against your own account, with no key to paste.