FOfoudroyer
Audit

Get audit by ID

Retrieves a single audit by ID. User must own the website associated with the audit.

post/audit/get_audit

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

audit_idstring required

Unique identifier of the audit to fetch

Response

The audit details

idstring required

Unique identifier of the audit

fk_website_idstring required

Website ID the audit belongs to

status'pending' | 'in_progress' | 'completed' | 'failed' | 'cancelled' required

Audit status

max_pages_limitnumber required

Maximum number of pages to crawl

started_atstring date-time required

When the audit was started

completed_atobject nullable required

When the audit was completed

cancelled_atobject nullable required

When the audit was cancelled

total_pages_foundnumber required

Total pages found during crawl

total_pages_crawlednumber required

Total pages crawled

total_orphan_pagesnumber required

Total orphan pages found

max_depth_crawlednumber nullable required

Maximum depth reached during crawl

overall_scorenumber nullable required

Overall audit score

http_code_distributionobject nullable required

HTTP status code distribution

created_atstring date-time required

When the audit was created

updated_atstring date-time required

When the audit was last updated

Example response

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

Changes

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