startSiteAudit
Analyze a domain’s pages for Open Graph, social media, and SEO metadata quality. Get an AI overview with per-page scores and prioritized recommendations.
Instructions
Start a full site audit for a domain. Audits each page for Open Graph, social media, and SEO metadata quality, then generates an AI-powered overview and per-page scores.
The urls array can be sourced from anywhere — discoverSiteUrls structured output, a codebase route scan (read route files and construct full URLs), a sitemap, or a manually provided list. Calling discoverSiteUrls first is NOT required.
For 'audit all': pass every URL from discoverSiteUrls structured output directly. For 'codebase scan': find routes in the project files (Next.js app/, pages/, React Router config, etc.), prepend the domain, and pass them here. If urls is omitted the backend crawls the domain internally.
Audits are asynchronous and can take several minutes. This tool returns an audit ID immediately — use getSiteAuditStatus to poll progress, then getSiteAuditReport to retrieve the completed report.
Pick the right tool: discoverSiteUrls → Crawl-based page discovery (use when you don't have the codebase) startSiteAudit → Run the audit — accepts URLs from any source getSiteAuditStatus → Poll until COMPLETE getSiteAuditReport → Get the full report previewPageAudit → Instantly audit a single URL without waiting
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| urls | No | Specific URLs to audit. Pass the user-selected subset from **discoverSiteUrls**. When omitted, the audit crawls the domain internally. | |
| domain | Yes | The domain to audit. Include the protocol (e.g. https://example.com). | |
| pagesRequested | No | Number of pages to audit (1–500). Defaults to the length of the `urls` array if provided, otherwise 10. Your plan's monthly URL quota limits the maximum across all audits. | |
| siteContextText | No | Homepage text from **discoverSiteUrls** structured output (`siteContextText`). Including this enriches the AI-generated overview and top-priority analysis. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| domain | Yes | ||
| status | Yes | Initial status — always QUEUED on creation | |
| auditId | Yes | ID to pass to getSiteAuditStatus and getSiteAuditReport | |
| pagesRequested | Yes |