start_site_audit
Start site audit
Use this when the user asks for a technical SEO audit, a site crawl, or a check for broken links, redirect problems, duplicate or missing titles and meta descriptions, canonical or hreflang errors, sitemap problems, or pages that are hard to find from the home page. Takes a site address (a domain such as example.com or a full URL; the scheme is optional) and starts a crawl of that site, then returns an audit_id, the page limit and a time estimate to relay to the user. The crawl follows robots.txt, is rate limited, and usually takes a few minutes. The number of pages crawled is capped; the report says when the cap was reached. If the address redirects (http to https, or to www), the final site is audited. Only use it for sites the user owns or is allowed to audit.
Parametersurlrequired
get_audit_status
Check audit status
Use this after start_site_audit to check whether the audit has finished. Takes the audit_id. Returns status (queued, running, completed, failed or canceled), pages crawled so far, the page limit, and any notes or error text. If the status is failed, the error field says why (for example the site blocked the crawler or robots.txt disallows it). Also returns phase, a plain-English message with the stage, pages crawled and time left, progress_pct, stalled and next_check_after_s. After each call, show the user the message, then call again after next_check_after_s seconds (20 to 30) until the status is completed, failed or canceled. When completed it also returns report_url, pdf_url and csv_url.
Parametersaudit_idrequired
get_audit_report
Get audit report
Use this once get_audit_status shows completed. Takes the audit_id and an optional top_n (1 to 25, default 10). Returns the issues ranked by likely impact, each with the number of affected pages, example URLs and a plain-English fix, plus a list of what was checked, what was not checked, and a note when the page limit was reached, and the full_report_url, pdf_url and csv_url links. Report the issues as given; do not add findings that are not in the result.
Parameterstop_naudit_idrequired