FOfoudroyer
Audit

Get audits quota usage

Returns monthly audit quota usage for the user (limit, used, remaining). Optionally pass pages_to_crawl to check if starting an audit with that many pages is allowed. User must own the website.

get/audit/quota

Request

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

Query parameters

website_idstring required

Website ID to get quota for (user must own it)

pages_to_crawlnumber

Optional. Number of pages to crawl for a planned audit; used to compute can_start.

Response

Quota limit, used, remaining, and optionally can_start for requested pages

quota_limitnumber required

Monthly quota limit for audits

quota_usednumber required

Pages already used this month

quota_remainingnumber required

Remaining pages in the monthly quota

requested_pagesnumber required

Requested pages for the audit

can_startboolean required

Whether the audit can be started

Changes

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