Site Audit
Commands and options for site audit.
audit-campaigns
Existing Site Audit campaigns; does not start a crawl.
semrush audit-campaigns --helpMCP tool: audit_campaigns.
audit-limits
Site Audit account crawl and project limits.
semrush audit-limits --helpMCP tool: audit_limits.
audit-info
Current Site Audit configuration, status and latest summary.
semrush audit-info --helpMCP tool: audit_info.
| Option | Type | Default | Description |
|---|---|---|---|
--campaign-id | integer | Required. SEO project/campaign ID from project-enable-seo, not the folder ID. |
audit-js-impact-guide
JavaScript rendering impact summary and changed-page examples by parameter.
semrush audit-js-impact-guide --helpMCP tool: audit_js_impact_guide.
| Option | Type | Default | Description |
|---|---|---|---|
--campaign-id | integer | Required. SEO project/campaign ID from project-enable-seo, not the folder ID. |
audit-js-impact-changed-pages
Number of Site Audit pages changed by JavaScript rendering.
semrush audit-js-impact-changed-pages --helpMCP tool: audit_js_impact_changed_pages.
| Option | Type | Default | Description |
|---|---|---|---|
--campaign-id | integer | Required. SEO project/campaign ID from project-enable-seo, not the folder ID. |
audit-js-impact-pages
Paginated Site Audit before/after JavaScript rendering values and filters.
semrush audit-js-impact-pages --helpMCP tool: audit_js_impact_pages.
| Option | Type | Default | Description |
|---|---|---|---|
--campaign-id | integer | Required. SEO project/campaign ID from project-enable-seo, not the folder ID. | |
--status | string | "all" | Compare pages before and after JavaScript rendering. Values: "all", "changed", "unchanged". |
--query | string | "" | URL search text. |
--parameters | array | [] | Changed parameter keys. Requires status changed. |
--sort | string | "desc" | Values: "asc", "desc". |
--page | integer | 0 | Zero-based page number. |
--limit | integer | 10 |
audit-export-js-impact
Download all matching JavaScript impact rows as native CSV or XLSX.
semrush audit-export-js-impact --helpMCP tool: audit_export_js_impact.
Pass --output <path> to save the file. Existing files are not overwritten. MCP returns an artifact resource.
| Option | Type | Default | Description |
|---|---|---|---|
--campaign-id | integer | Required. SEO project/campaign ID from project-enable-seo, not the folder ID. | |
--status | string | "all" | Compare pages before and after JavaScript rendering. Values: "all", "changed", "unchanged". |
--query | string | "" | URL search text. |
--parameters | array | [] | Changed parameter keys. Requires status changed. |
--sort | string | "desc" | Values: "asc", "desc". |
--format | string | "csv" | Values: "csv", "xlsx". |
audit-status
Current Site Audit execution status.
semrush audit-status --helpMCP tool: audit_status.
| Option | Type | Default | Description |
|---|---|---|---|
--campaign-id | integer | Required. SEO project/campaign ID from project-enable-seo, not the folder ID. |
audit-snapshots
Historical Site Audit crawl snapshots.
semrush audit-snapshots --helpMCP tool: audit_snapshots.
| Option | Type | Default | Description |
|---|---|---|---|
--campaign-id | integer | Required. SEO project/campaign ID from project-enable-seo, not the folder ID. |
audit-snapshot
Read a specific Site Audit snapshot.
semrush audit-snapshot --helpMCP tool: audit_snapshot.
| Option | Type | Default | Description |
|---|---|---|---|
--campaign-id | integer | Required. SEO project/campaign ID from project-enable-seo, not the folder ID. | |
--snapshot-id | string | Required. Opaque snapshot ID returned by audit-start or audit-snapshots. |
audit-start
Start a configured Site Audit. Consumes crawl allowance and uses its saved notification settings.
semrush audit-start --helpMCP tool: audit_start.
Use --confirm to send the change or --dry-run to preview it.
| Option | Type | Default | Description |
|---|---|---|---|
--campaign-id | integer | Required. SEO project/campaign ID from project-enable-seo, not the folder ID. | |
--confirm | boolean | false | Confirm this account mutation. |
--dry-run | boolean | false | Print the request without sending it. |
audit-configure
Replace Site Audit settings without starting a crawl. Defaults to manual scheduling and no email. Supports HTTP Basic and Web Bot Auth credentials with explicit retention or disabling. Google Analytics connections require the web UI.
semrush audit-configure --helpMCP tool: audit_configure.
Use --confirm to send the change or --dry-run to preview it.
| Option | Type | Default | Description |
|---|---|---|---|
--campaign-id | integer | Required. SEO project/campaign ID from project-enable-seo, not the folder ID. | |
--domain | string | Required. Domain or subdomain, without protocol or path. | |
--page-limit | integer | Required. Maximum pages to crawl. Your plan limit still applies. | |
--schedule-day | integer | 0 | 0 manual, 1-7 Monday-Sunday, 8 daily. Values: 0, 1, 2, 3, 4, 5, 6, 7, 8. |
--notify | boolean | false | |
--user-agent-type | integer | 8 | Values: 0, 1, 2, 3, 7, 8, 9. |
--crawl-subdomains | boolean | false | |
--crawl-source-type | integer | 0 | 0 website, 1 robots sitemap, 2 custom sitemap URL, 3 uploaded URL list. Values: 0, 1, 2, 3. |
--crawl-source-url | string | "" | Custom sitemap URL for source type 2. Leave empty for an uploaded URL list; uploads belong to the campaign. |
--crawl-delay | integer | 1 | Values: 1, 2, 3. |
--ignore-robots-disallow | boolean | false | |
--js-rendering | string | "DISABLED" | Values: "DISABLED", "RENDER_ALL". |
--scheme | string | "https" | Values: "http", "https". |
--allow | array | [] | |
--disallow | array | [] | |
--removed-parameters | array | [] | |
--excluded-checks | array | [] | |
--confirm | boolean | false | Confirm this account mutation. |
--dry-run | boolean | false | Print the request without sending it. |
--auth-enabled | boolean | Enable HTTP basic authentication. Explicitly choose true to retain existing credentials or false to disable it on a protected audit. | |
--auth-username | string | HTTP basic-auth username. Supply both credential fields when changing them. | |
--auth-password-file | file or stdin | HTTP basic-auth password. CLI reads --auth-password-file PATH, or - for stdin; never a command argument value. | |
--web-bot-auth-enabled | boolean | Enable Web Bot Auth. Choose true to retain existing credentials, or false to explicitly disable it on an authenticated audit. | |
--web-bot-auth-file | file or stdin | Complete native Signature-Agent, Signature-Input and Signature header values. CLI reads --web-bot-auth-file PATH or - for stdin. Supply all fields together when creating or replacing credentials. |
audit-create
Create Site Audit settings on an SEO project without starting a crawl. Refuses to replace an existing audit. Defaults to manual scheduling and no email.
semrush audit-create --helpMCP tool: audit_create.
Use --confirm to send the change or --dry-run to preview it.
| Option | Type | Default | Description |
|---|---|---|---|
--campaign-id | integer | Required. SEO project/campaign ID from project-enable-seo, not the folder ID. | |
--domain | string | Required. Domain or subdomain, without protocol or path. | |
--page-limit | integer | Required. Maximum pages to crawl. Your plan limit still applies. | |
--schedule-day | integer | 0 | 0 manual, 1-7 Monday-Sunday, 8 daily. Values: 0, 1, 2, 3, 4, 5, 6, 7, 8. |
--notify | boolean | false | |
--user-agent-type | integer | 8 | Values: 0, 1, 2, 3, 7, 8, 9. |
--crawl-subdomains | boolean | false | |
--crawl-source-type | integer | 0 | 0 website, 1 robots sitemap, 2 custom sitemap URL, 3 uploaded URL list. Values: 0, 1, 2, 3. |
--crawl-source-url | string | "" | Custom sitemap URL for source type 2. Leave empty for an uploaded URL list; uploads belong to the campaign. |
--crawl-delay | integer | 1 | Values: 1, 2, 3. |
--ignore-robots-disallow | boolean | false | |
--js-rendering | string | "DISABLED" | Values: "DISABLED", "RENDER_ALL". |
--scheme | string | "https" | Values: "http", "https". |
--allow | array | [] | |
--disallow | array | [] | |
--removed-parameters | array | [] | |
--excluded-checks | array | [] | |
--confirm | boolean | false | Confirm this account mutation. |
--dry-run | boolean | false | Print the request without sending it. |
--auth-enabled | boolean | Enable HTTP basic authentication. Explicitly choose true to retain existing credentials or false to disable it on a protected audit. | |
--auth-username | string | HTTP basic-auth username. Supply both credential fields when changing them. | |
--auth-password-file | file or stdin | HTTP basic-auth password. CLI reads --auth-password-file PATH, or - for stdin; never a command argument value. | |
--web-bot-auth-enabled | boolean | Enable Web Bot Auth. Choose true to retain existing credentials, or false to explicitly disable it on an authenticated audit. | |
--web-bot-auth-file | file or stdin | Complete native Signature-Agent, Signature-Input and Signature header values. CLI reads --web-bot-auth-file PATH or - for stdin. Supply all fields together when creating or replacing credentials. |
audit-pages
Read the current crawled-page table. Pagination is zero-based.
semrush audit-pages --helpMCP tool: audit_pages.
| Option | Type | Default | Description |
|---|---|---|---|
--campaign-id | integer | Required. | |
--page | integer | 0 | |
--limit | integer | 20 | |
--sort | string | "url_asc" | |
--filter | string | ||
--filter-type | string | Values: "url", "title", "meta_description". |
audit-page
Read one crawled page and its issue details.
semrush audit-page --helpMCP tool: audit_page.
| Option | Type | Default | Description |
|---|---|---|---|
--campaign-id | integer | Required. | |
--page-id | string | Required. |
audit-issue
Read affected-page rows for one issue in a snapshot. Requests use one-based pages.
semrush audit-issue --helpMCP tool: audit_issue.
| Option | Type | Default | Description |
|---|---|---|---|
--campaign-id | integer | Required. | |
--snapshot-id | string | Required. | |
--issue-id | integer | Required. | |
--page | integer | 1 | |
--limit | integer | 10 | |
--sort | string | "index_asc" | |
--visible | boolean | true | |
--filter | string | ||
--search | string |
audit-structure
Read crawl directory structure and page/issue counts.
semrush audit-structure --helpMCP tool: audit_structure.
| Option | Type | Default | Description |
|---|---|---|---|
--campaign-id | integer | Required. |
audit-performance
Read crawl performance distributions and load-time history.
semrush audit-performance --helpMCP tool: audit_performance.
| Option | Type | Default | Description |
|---|---|---|---|
--campaign-id | integer | Required. |
audit-linking
Read internal link distribution, depth and linking issues.
semrush audit-linking --helpMCP tool: audit_linking.
| Option | Type | Default | Description |
|---|---|---|---|
--campaign-id | integer | Required. |
audit-history
Read paginated completed-crawl progress metrics.
semrush audit-history --helpMCP tool: audit_history.
| Option | Type | Default | Description |
|---|---|---|---|
--campaign-id | integer | Required. | |
--limit | integer | 7 | |
--offset | integer | 0 |
audit-recrawl
Recrawl one page explicitly. Consumes crawl allowance.
semrush audit-recrawl --helpMCP tool: audit_recrawl.
Use --confirm to send the change or --dry-run to preview it.
| Option | Type | Default | Description |
|---|---|---|---|
--campaign-id | integer | Required. | |
--page-id | string | Required. | |
--confirm | boolean | false | |
--dry-run | boolean | false |
audit-abort
Abort an active crawl and discard its in-progress results.
semrush audit-abort --helpMCP tool: audit_abort.
Use --confirm to send the change or --dry-run to preview it.
| Option | Type | Default | Description |
|---|---|---|---|
--campaign-id | integer | Required. | |
--confirm | boolean | false | |
--dry-run | boolean | false |
audit-finalize
Stop an active crawl and keep results already collected.
semrush audit-finalize --helpMCP tool: audit_finalize.
Use --confirm to send the change or --dry-run to preview it.
| Option | Type | Default | Description |
|---|---|---|---|
--campaign-id | integer | Required. | |
--confirm | boolean | false | |
--dry-run | boolean | false |
audit-execution
Read current crawl phases, progress and whether stopping is allowed.
semrush audit-execution --helpMCP tool: audit_execution.
| Option | Type | Default | Description |
|---|---|---|---|
--campaign-ids | array | Required. |
audit-export-pages
Download crawled-page data as CSV or XLSX.
semrush audit-export-pages --helpMCP tool: audit_export_pages.
Pass --output <path> to save the file. Existing files are not overwritten. MCP returns an artifact resource.
| Option | Type | Default | Description |
|---|---|---|---|
--snapshot-id | string | Required. | |
--format | string | "csv" | Values: "csv", "xlsx". |
--relative | boolean | false | |
--sort | string | "url_asc" | |
--filter | string | "" |
audit-export-page-issues
Download the latest campaign crawl as a page-by-issue matrix in CSV or XLSX.
semrush audit-export-page-issues --helpMCP tool: audit_export_page_issues.
Pass --output <path> to save the file. Existing files are not overwritten. MCP returns an artifact resource.
| Option | Type | Default | Description |
|---|---|---|---|
--campaign-id | integer | Required. SEO project/campaign ID from project-enable-seo, not the folder ID. | |
--format | string | "csv" | Values: "csv", "xlsx". |
--relative | boolean | false | |
--sort | string | "url_asc" | |
--filter | string | "" |
audit-export-markup
Download crawled-page markup and structured-data columns as CSV or XLSX.
semrush audit-export-markup --helpMCP tool: audit_export_markup.
Pass --output <path> to save the file. Existing files are not overwritten. MCP returns an artifact resource.
| Option | Type | Default | Description |
|---|---|---|---|
--snapshot-id | string | Required. | |
--format | string | "csv" | Values: "csv", "xlsx". |
--relative | boolean | false | |
--sort | string | "url_asc" | |
--filter | string | "" |
audit-export-issues
Download the snapshot issue summary as CSV or XLSX.
semrush audit-export-issues --helpMCP tool: audit_export_issues.
Pass --output <path> to save the file. Existing files are not overwritten. MCP returns an artifact resource.
| Option | Type | Default | Description |
|---|---|---|---|
--snapshot-id | string | Required. | |
--format | string | "csv" | Values: "csv", "xlsx". |
audit-export-compare
Download a native CSV or XLSX comparison of two different Site Audit crawls.
semrush audit-export-compare --helpMCP tool: audit_export_compare.
Pass --output <path> to save the file. Existing files are not overwritten. MCP returns an artifact resource.
| Option | Type | Default | Description |
|---|---|---|---|
--first-snapshot-id | string | Required. First comparison snapshot, normally the previous crawl. | |
--second-snapshot-id | string | Required. Second comparison snapshot, normally the latest crawl. Native output columns appear before the first snapshot. | |
--format | string | "csv" | Values: "csv", "xlsx". |
audit-export-issue
Download affected-page rows for one issue as CSV or XLSX.
semrush audit-export-issue --helpMCP tool: audit_export_issue.
Pass --output <path> to save the file. Existing files are not overwritten. MCP returns an artifact resource.
| Option | Type | Default | Description |
|---|---|---|---|
--snapshot-id | string | Required. | |
--format | string | "csv" | Values: "csv", "xlsx". |
--issue-id | integer | Required. | |
--sort | string | "index_asc" |
audit-urls-upload
Upload a text or CSV crawl URL list to an SEO project. Returns a filename and count; does not configure or start an audit.
semrush audit-urls-upload --helpMCP tool: audit_urls_upload.
Use --confirm to send the change or --dry-run to preview it.
| Option | Type | Default | Description |
|---|---|---|---|
--campaign-id | integer | Required. SEO project/campaign ID from project-enable-seo, not the folder ID. | |
--contents-file | file or stdin | Required. Text or CSV URL list, one absolute or relative URL per line. CLI reads --contents-file PATH, or - for stdin. | |
--filename | string | "semrush-crawl-urls.txt" | Upload filename, ending in .txt or .csv. |
--confirm | boolean | false | Confirm this account mutation. |
--dry-run | boolean | false | Print the request without sending it. |
audit-export-all
Download available Site Audit reports as a CLI-created ZIP with untouched native CSV/XLSX files and an availability manifest.
semrush audit-export-all --helpMCP tool: audit_export_all.
Pass --output <path> to save the file. Existing files are not overwritten. MCP returns an artifact resource.
| Option | Type | Default | Description |
|---|---|---|---|
--campaign-id | integer | Required. SEO project/campaign ID from project-enable-seo, not the folder ID. | |
--format | string | "csv" | Values: "csv", "xlsx". |
--relative | boolean | false | |
--sort | string | "url_asc" | |
--filter | string | "" |