Run an audit pass: scan the domain's key pages, refresh page_scans, file findings

POST

/v1/audit/run

curl --request POST \
  --url https://api.monita.ai/v1/audit/run \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "domainId": "example", "paths": [ "example" ] }'

Authorizations

• bearerAuth

Request Body

Media typeapplication/json

object

domainId

required

string

>= 1 characters

paths

Array<string>

<= 8 items

Example^generated

{
  "domainId": "example",
  "paths": [
    "example"
  ]
}

Responses

200

OK

Media typeapplication/json

object

scanned

required

number

errors

required

number

issuesFiled

required

number

Example^generated

{
  "scanned": 1,
  "errors": 1,
  "issuesFiled": 1
}

404

Not found

Media typeapplication/json

object

error

required

string

Example^generated

{
  "error": "example"
}

503

Browser Rendering unavailable

Media typeapplication/json

object

error

required

string

Example^generated

{
  "error": "example"
}