Type at least two letters.

    ↑ ↓ to moveEnter to open

    Audit runs API

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

    Updated

    5 live operations. 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.

    Run the URL policy without starting an audit

    POST/api/v1/url-checks
    Scope: audits:readoperationId: checkUrl

    Request body

    urlstring (uri)required
    {
      "url": "https://www.example.com"
    }

    Responses

    200object

    Policy result

    3 fields
    allowedbooleanrequired
    normalisedUrlstring (uri)
    reasonsarray of string
    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.

    List audit runs, newest first

    GET/api/v1/audit-runs
    Scope: audits:readoperationId: listAuditRuns

    Parameters

    cursorstring · query
    limitinteger · query
    siteIdstring · query
    statusstring · query
    sincestring (date-time) · query
    labelstring · query

    Filter by a label, `key:value`.

    Responses

    200object

    Runs, newest first

    2 fields
    nextCursorstring or null
    dataarray of AuditRun
    21 fields of data
    idstringrequired
    siteIdstringrequired
    requestedUrlstring (uri)
    resolvedUrlstring or null (uri)
    scheduledForstring or null (date-time)
    createdAtstring (date-time)
    errorCodestring or null

    Set when `status` is `failed`, for example `url_policy_denied`, or `verification_lost` when the ownership proof of a deep audit is gone.

    startedAtstring or null (date-time)
    finishedAtstring or null (date-time)
    statusstringrequired

    One of: queued, running, succeeded, partial, failed

    triggerTypestringrequired

    One of: manual, scheduled, api, ci

    profileVersionstringrequired
    levelstring

    `passive` reads what every visitor sees and runs on any public site. `deep` adds requests a visitor would not make (for example files that should not be public) and runs only on a verified site.

    One of: passive, deep

    scopeobject

    The scope as it was when the audit was started.

    3 fields of scope
    idstring
    namestring
    checksinteger
    estimatedCreditsinteger

    The sum of the credits of the checks in this audit.

    creditsinteger or null

    Credits booked when the audit finished. 0 when it could not start; `null` while it runs.

    previousRunIdstring or null
    runtimeMetricsRuntimeMetrics or null
    6 fields of runtimeMetrics
    durationMsinteger
    subrequestsinteger
    psiCallsinteger
    cruxCallsinteger
    browserContextRunsinteger
    retriesinteger
    summaryarray of AreaSummary
    7 fields of summary
    areastring

    One of: availability, security, email, performance, marketing, accessibility, privacy, technology, exposure

    passinteger
    failinteger
    noDatainteger
    notTestedinteger
    regressedinteger
    improvedinteger
    labelsLabels

    Free key-value pairs, e.g. release, pipeline, NeoLoad test ID, Jira key.

    linksobject
    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.

    Queue an audit. Returns at once; the run is asynchronous.

    POST/api/v1/audit-runs
    Scope: audits:writeoperationId: startAuditRun

    Parameters

    Idempotency-Keystring · headerrequired

    Same key within 24 h returns the same response; a different body returns 409.

    Request body AuditRunCreate

    siteIdstringrequired
    levelobject

    `deep` answers 403 `verification_required` unless the site is verified.

    Default: passive

    scopestring

    Which checks to run: `full`, `area:<area>` or the id of a saved scope (`GET /audit-scopes`). A passive audit runs the passive checks of the scope; if there are none, 400 `empty_scope`.

    Default: full

    ruleIdsarray of string

    An own selection of checks for this one run, without saving a scope: check ids from `GET /rules`. Send either `scope` or `ruleIds`, not both (400 `invalid_request`). The run reports the scope `custom`. A passive audit runs the passive checks of the selection; if there are none, 400 `empty_scope`.

    urlsarray of string (uri)

    Defaults to the site's deep-audit pages.

    At most 20 items

    profileIdstring

    Default: prof_mobile_v1

    areasarray of string
    scheduledForstring (date-time)

    Start no earlier than this time (within 90 days). Omit to start now.

    baselinestring

    `previous` (default), `none`, or a run ID to compare with.

    labelsLabels

    Free key-value pairs, e.g. release, pipeline, NeoLoad test ID, Jira key.

    {
      "siteId": "site_01JC9Z0000000000000000000"
    }

    Responses

    202AuditRun

    Accepted

    Header Location

    21 fields
    idstringrequired
    siteIdstringrequired
    requestedUrlstring (uri)
    resolvedUrlstring or null (uri)
    scheduledForstring or null (date-time)
    createdAtstring (date-time)
    errorCodestring or null

    Set when `status` is `failed`, for example `url_policy_denied`, or `verification_lost` when the ownership proof of a deep audit is gone.

    startedAtstring or null (date-time)
    finishedAtstring or null (date-time)
    statusstringrequired

    One of: queued, running, succeeded, partial, failed

    triggerTypestringrequired

    One of: manual, scheduled, api, ci

    profileVersionstringrequired
    levelstring

    `passive` reads what every visitor sees and runs on any public site. `deep` adds requests a visitor would not make (for example files that should not be public) and runs only on a verified site.

    One of: passive, deep

    scopeobject

    The scope as it was when the audit was started.

    3 fields of scope
    idstring
    namestring
    checksinteger
    estimatedCreditsinteger

    The sum of the credits of the checks in this audit.

    creditsinteger or null

    Credits booked when the audit finished. 0 when it could not start; `null` while it runs.

    previousRunIdstring or null
    runtimeMetricsRuntimeMetrics or null
    6 fields of runtimeMetrics
    durationMsinteger
    subrequestsinteger
    psiCallsinteger
    cruxCallsinteger
    browserContextRunsinteger
    retriesinteger
    summaryarray of AreaSummary
    7 fields of summary
    areastring

    One of: availability, security, email, performance, marketing, accessibility, privacy, technology, exposure

    passinteger
    failinteger
    noDatainteger
    notTestedinteger
    regressedinteger
    improvedinteger
    labelsLabels

    Free key-value pairs, e.g. release, pipeline, NeoLoad test ID, Jira key.

    linksobject
    409Problem (application/problem+json)

    RFC 9457 problem

    429Problem (application/problem+json)

    RFC 9457 problem

    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.

    Get one audit run; poll this until the status is final

    GET/api/v1/audit-runs/{runId}
    Scope: audits:readoperationId: getAuditRun

    Parameters

    runIdstring · pathrequired
    waitinteger · query

    Long-poll up to this many seconds while the run is not final.

    Responses

    200AuditRun

    Run

    Header Retry-After: Present while the run is queued or running.

    21 fields
    idstringrequired
    siteIdstringrequired
    requestedUrlstring (uri)
    resolvedUrlstring or null (uri)
    scheduledForstring or null (date-time)
    createdAtstring (date-time)
    errorCodestring or null

    Set when `status` is `failed`, for example `url_policy_denied`, or `verification_lost` when the ownership proof of a deep audit is gone.

    startedAtstring or null (date-time)
    finishedAtstring or null (date-time)
    statusstringrequired

    One of: queued, running, succeeded, partial, failed

    triggerTypestringrequired

    One of: manual, scheduled, api, ci

    profileVersionstringrequired
    levelstring

    `passive` reads what every visitor sees and runs on any public site. `deep` adds requests a visitor would not make (for example files that should not be public) and runs only on a verified site.

    One of: passive, deep

    scopeobject

    The scope as it was when the audit was started.

    3 fields of scope
    idstring
    namestring
    checksinteger
    estimatedCreditsinteger

    The sum of the credits of the checks in this audit.

    creditsinteger or null

    Credits booked when the audit finished. 0 when it could not start; `null` while it runs.

    previousRunIdstring or null
    runtimeMetricsRuntimeMetrics or null
    6 fields of runtimeMetrics
    durationMsinteger
    subrequestsinteger
    psiCallsinteger
    cruxCallsinteger
    browserContextRunsinteger
    retriesinteger
    summaryarray of AreaSummary
    7 fields of summary
    areastring

    One of: availability, security, email, performance, marketing, accessibility, privacy, technology, exposure

    passinteger
    failinteger
    noDatainteger
    notTestedinteger
    regressedinteger
    improvedinteger
    labelsLabels

    Free key-value pairs, e.g. release, pipeline, NeoLoad test ID, Jira key.

    linksobject
    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.

    The results of one audit run, one per check

    GET/api/v1/audit-runs/{runId}/observations
    Scope: audits:readoperationId: listObservations

    Parameters

    runIdstring · pathrequired
    cursorstring · query
    limitinteger · query
    areastring · query
    statusstring · query

    `failed` means the measurement failed, not the site.

    minSeveritystring · query

    Responses

    200object

    Observations

    2 fields
    nextCursorstring or null
    dataarray of Observation
    19 fields of data
    idstringrequired
    auditRunIdstringrequired
    urlstring (uri)
    areastringrequired

    One of: availability, security, email, performance, marketing, accessibility, privacy, technology, exposure

    ruleIdstringrequired
    ruleVersionstring
    statusstringrequired

    `failed` means the measurement failed, not the site.

    One of: pass, fail, no_data, not_tested, failed

    severitystringrequired

    One of: info, low, medium, high

    confidencestringrequired

    One of: low, medium, high

    summarystring
    evidenceRefsarray of string
    rawValuestring or number or null
    unitstring or null
    compareAsstring

    One of: status, metric, score

    previousStatusstring or null
    previousValuestring or number or null
    noisenumber or null

    Noise band for the metric; a change inside it is `unchanged`.

    changestring

    One of: improved, regressed, unchanged, no_data

    createdAtstring (date-time)
    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.