semrush cli
Commands

Core Web Vitals

Commands and options for core web vitals.

audit-web-vitals-status

Read Core Web Vitals availability, score and score delta.

semrush audit-web-vitals-status --help

MCP tool: audit_web_vitals_status.

OptionTypeDefaultDescription
--campaign-idintegerRequired. SEO project/campaign ID from project-enable-seo, not the folder ID.

audit-web-vitals-overview

Read native Core Web Vitals score and dated page-status counts.

semrush audit-web-vitals-overview --help

MCP tool: audit_web_vitals_overview.

OptionTypeDefaultDescription
--campaign-idintegerRequired. SEO project/campaign ID from project-enable-seo, not the folder ID.

audit-web-vitals-pages

Read all measured URLs and their native LCP, TBT and CLS values. Retains signed URL IDs as strings.

semrush audit-web-vitals-pages --help

MCP tool: audit_web_vitals_pages.

OptionTypeDefaultDescription
--campaign-idintegerRequired. SEO project/campaign ID from project-enable-seo, not the folder ID.

audit-web-vitals-history

Read native metric history for one exact signed URL ID.

semrush audit-web-vitals-history --help

MCP tool: audit_web_vitals_history.

OptionTypeDefaultDescription
--campaign-idintegerRequired. SEO project/campaign ID from project-enable-seo, not the folder ID.
--url-idstringRequired. Exact signed decimal urlId from audit-web-vitals-pages. Keep it as a string, including a leading minus sign.

audit-web-vitals-recommendations

Read native Lighthouse recommendations for one exact signed URL ID.

semrush audit-web-vitals-recommendations --help

MCP tool: audit_web_vitals_recommendations.

OptionTypeDefaultDescription
--campaign-idintegerRequired. SEO project/campaign ID from project-enable-seo, not the folder ID.
--url-idstringRequired. Exact signed decimal urlId from audit-web-vitals-pages. Keep it as a string, including a leading minus sign.

audit-web-vitals-improvements

Read native top improvements and affected-page statistics.

semrush audit-web-vitals-improvements --help

MCP tool: audit_web_vitals_improvements.

OptionTypeDefaultDescription
--campaign-idintegerRequired. SEO project/campaign ID from project-enable-seo, not the folder ID.

audit-web-vitals-settings

Read the saved Core Web Vitals URL selection and pending-change flag.

semrush audit-web-vitals-settings --help

MCP tool: audit_web_vitals_settings.

OptionTypeDefaultDescription
--campaign-idintegerRequired. SEO project/campaign ID from project-enable-seo, not the folder ID.

audit-web-vitals-settings-set

Replace the complete Core Web Vitals URL list for the next audit. Requires one to ten URLs; the native API rejects empty lists. Does not launch a crawl; partial acceptance requires inspecting the saved list before another write.

semrush audit-web-vitals-settings-set --help

MCP tool: audit_web_vitals_settings_set.

Use --confirm to send the change or --dry-run to preview it.

OptionTypeDefaultDescription
--campaign-idintegerRequired. SEO project/campaign ID from project-enable-seo, not the folder ID.
--urlsarrayRequired. One to ten unique absolute HTTP(S) URLs. Replaces the full saved selection.
--confirmbooleanfalse
--dry-runbooleanfalse

audit-web-vitals-pdf

Generate the native Core Web Vitals PDF from an existing Site Audit and save its Essential report in My Reports. Uses reporting allowance; no crawl, email or schedule.

semrush audit-web-vitals-pdf --help

MCP tool: audit_web_vitals_pdf.

Use --confirm to send the change or --dry-run to preview it.

Pass --output <path> to save the file. Existing files are not overwritten. MCP returns an artifact resource.

OptionTypeDefaultDescription
--campaign-idintegerRequired. SEO project/campaign ID from project-enable-seo, not the folder ID.
--confirmbooleanfalseConfirm report creation, privacy acceptance and PDF generation.
--dry-runbooleanfalsePreview the export without account access.
--ai-summarybooleanfalseInclude the native AI Summary widget. Uses your account AI summary allowance.

On this page