Create and start an audit run

POST

/v1/audits

curl --request POST \
  --url https://api.monita.ai/v1/audits \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "kind": "property", "name": "example", "domainId": "example", "paths": [ "example" ], "fetchSitemap": true, "sitemapUrl": "https://example.com", "url": "https://example.com", "injectCookies": [ { "name": "example", "value": "example", "domain": "example" } ], "advanced": { "region": "example", "proxies": true, "bypassBanners": true, "consentInstruction": "example" }, "overage": false }'

Authorizations

• bearerAuth

Request Body

Media typeapplication/json

object

kind

string

default: property

Allowed values: property url campaign

name

string

<= 120 characters

domainId

string

paths

Array<string>

<= 500 items

fetchSitemap

boolean

sitemapUrl

string format: uri

<= 500 characters

url

string format: uri

<= 2000 characters

injectCookies

Array<object>

<= 20 items

object

name

required

string

>= 1 characters <= 200 characters

value

required

string

<= 2000 characters

domain

string

<= 200 characters

advanced

object

region

string

<= 30 characters

proxies

boolean

bypassBanners

boolean

consentInstruction

string

<= 300 characters

overage

boolean

Responses

201

Started

Media typeapplication/json

object

id

required

string

kind

required

string

Allowed values: property url campaign

tier

required

string

Allowed values: simple advanced

status

required

string

Allowed values: queued running done error canceled

name

required

string

nullable

startedBy

required

string

nullable

targetHost

required

string

nullable

domainId

required

string

nullable

domain

required

string

nullable

pagesRequested

required

number

pagesScanned

required

number

pagesErrored

required

number

issuesFiled

required

number

summary

required

object

key

additional properties

nullable

shared

required

boolean

error

required

string

nullable

createdAt

required

number

finishedAt

required

number

nullable

Example

{
  "kind": "property",
  "tier": "simple",
  "status": "queued"
}

400

Bad target

Media typeapplication/json

object

error

required

string

Example^generated

{
  "error": "example"
}

402

Over the monthly page budget (send overage: true to consent)

Media typeapplication/json

object

error

required

string

pages

required

number

remaining

required

number

budget

required

number

Example^generated

{
  "error": "example",
  "pages": 1,
  "remaining": 1,
  "budget": 1
}

404

Domain 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"
}