---
title: "Start an audit"
method: POST
path: "/audit/start"
tags: ["Audit"]
---

# Start an audit

`POST /audit/start`

## Request

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

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

## Request body

- AuditStartInputDto
  - `website_id` string, required: Unique identifier of the website to audit
  - `max_pages_limit` number: Maximum number of pages to crawl (limited by plan: indexation=10k, teams=20k, enterprise=40k)

## Response `200`

The created audit

- AuditStartOutputDto
  - `audit` AuditEntity, required
    - `id` string, required: Unique identifier of the audit
    - `fk_website_id` string, required: Website ID the audit belongs to
    - `status` 'pending' | 'in_progress' | 'completed' | 'failed' | 'cancelled', required: Audit status
    - `max_pages_limit` number, required: Maximum number of pages to crawl
    - `started_at` string, date-time, required: When the audit was started
    - `completed_at` object, nullable, required: When the audit was completed
    - `cancelled_at` object, nullable, required: When the audit was cancelled
    - `total_pages_found` number, required: Total pages found during crawl
    - `total_pages_crawled` number, required: Total pages crawled
    - `total_orphan_pages` number, required: Total orphan pages found
    - `max_depth_crawled` number, nullable, required: Maximum depth reached during crawl
    - `overall_score` number, nullable, required: Overall audit score
    - `http_code_distribution` object, nullable, required: HTTP status code distribution
    - `created_at` string, date-time, required: When the audit was created
    - `updated_at` string, date-time, required: When the audit was last updated

---

[API](https://skmtc.dev/foudroyer/apis/foudroyer-api.md) - [All operations](https://skmtc.dev/foudroyer/apis/foudroyer-api/llms.txt) - [OpenAPI document](https://skmtc.dev/foudroyer/apis/foudroyer-api/revisions/5b917c67e013?raw)