Audit

Start an audit

Starts a new audit for a website. User must own the website. Only one audit can be in progress per website.

post/audit/start

Request

  • Base URL
    https://api.foudroyer.com (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Request body

website_idstring required

Unique identifier of the website to audit

max_pages_limitnumber

Maximum number of pages to crawl (limited by plan: indexation=10k, teams=20k, enterprise=40k)

Response

The created audit

Example response

{
  "audit": {
    "http_code_distribution": {
      "200": 10,
      "404": 2,
      "500": 1
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.