semrush-cli

reporting-overview

Read reporting access, templates and a filtered page of saved reports.

semrush reporting-overview --help

MCP tool: reporting_overview.

Option	Type	Default	Description
`--offset`	integer	`0`	Native report offset. Advance by 30 to read the next page.
`--ownership`	string	`"all"`	Values: `"all"`, `"own"`, `"shared"`, `"team"`.
`--branding`	string	`"all"`	Values: `"all"`, `"branded"`, `"standard"`.
`--schedule`	string	`"all"`	Values: `"all"`, `"daily"`, `"weekly"`, `"monthly"`.
`--search`	string	`""`	Native report-name Contains search, combined with other filters.

reporting-create

Create a saved report from a system template. Does not generate a PDF or start a trial.

semrush reporting-create --help

MCP tool: reporting_create.

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

Option	Type	Default	Description
`--template`	string		Required. System template type from reporting-overview.
`--parameters`	object		Required. Template parameters, such as domain and database for Organic Search Positions.
`--confirm`	boolean	`false`	Confirm this account mutation.
`--dry-run`	boolean	`false`	Print the request without sending it.

reporting-get

Read the complete saved report document for inspection or editing.

semrush reporting-get --help

MCP tool: reporting_get.

Option	Type	Default	Description
`--report-id`	integer		Required.

reporting-save

Save a complete existing report document and accept the reporting Privacy Policy. Does not generate a PDF.

semrush reporting-save --help

MCP tool: reporting_save.

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

Option	Type	Default	Description
`--document-file`	file or stdin		Required. Complete document object from reporting-get. CLI accepts a JSON file.
`--timezone`	number	`0`	UTC offset in hours used by the reporting service.
`--confirm`	boolean	`false`	Confirm this account mutation.
`--dry-run`	boolean	`false`	Print the request without sending it.

reporting-clone

Clone an existing report under a new name. Does not generate a PDF.

semrush reporting-clone --help

MCP tool: reporting_clone.

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

Option	Type	Default	Description
`--report-id`	integer		Required.
`--name`	string		Required.
`--confirm`	boolean	`false`	Confirm this account mutation.
`--dry-run`	boolean	`false`	Print the request without sending it.

reporting-tasks

List the most recent 30 generation tasks for one saved report.

semrush reporting-tasks --help

MCP tool: reporting_tasks.

Option	Type	Default	Description
`--report-id`	integer		Required.

reporting-generate

Save and generate a PDF with the reporting Privacy Policy accepted. Uses saved report settings, including configured delivery.

semrush reporting-generate --help

MCP tool: reporting_generate.

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

Option	Type	Default	Description
`--report-id`	integer		Required.
`--timezone`	number	`0`	UTC offset in hours used when saving before generation.
`--confirm`	boolean	`false`	Confirm this account mutation.
`--dry-run`	boolean	`false`	Print the request without sending it.

reporting-download

Download an existing ready report task as a native PDF. Does not generate another report.

semrush reporting-download --help

MCP tool: reporting_download.

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

Option	Type	Default	Description
`--report-id`	integer		Required.
`--task-id`	string		Required. Exact task ID from reporting-tasks or reporting-generate.

reporting-delete

Delete the explicitly selected saved reports. Recovery is possible only while Semrush still retains them.

semrush reporting-delete --help

MCP tool: reporting_delete.

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

Option	Type	Default	Description
`--report-ids`	array		Required. Exact saved report IDs from reporting-overview.
`--confirm`	boolean	`false`	Confirm this account mutation.
`--dry-run`	boolean	`false`	Print the request without sending it.

reporting-shares

Read a report's shared access, including exact share IDs and roles.

semrush reporting-shares --help

MCP tool: reporting_shares.

Option	Type	Default	Description
`--report-id`	integer		Required.

Grant report access and send sharing notifications to the specified email addresses.

semrush reporting-share --help

MCP tool: reporting_share.

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

Option	Type	Default	Description
`--report-id`	integer		Required.
`--emails`	array		Required. Recipients who will receive access and sharing notifications.
`--role`	string		Required. Explicit permission for every selected share. Values: `"viewer"`, `"editor"`.
`--confirm`	boolean	`false`	Confirm this account mutation.
`--dry-run`	boolean	`false`	Print the request without sending it.

Change viewer/editor permissions for existing report shares.

semrush reporting-share-set-role --help

MCP tool: reporting_share_set_role.

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

Option	Type	Default	Description
`--share-ids`	array		Required. Exact share_id strings from reporting-shares, not report IDs.
`--role`	string		Required. Explicit permission for every selected share. Values: `"viewer"`, `"editor"`.
`--confirm`	boolean	`false`	Confirm this account mutation.
`--dry-run`	boolean	`false`	Print the request without sending it.

Revoke existing report shares and remove the recipients' access.

semrush reporting-share-revoke --help

MCP tool: reporting_share_revoke.

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

Option	Type	Default	Description
`--share-ids`	array		Required. Exact share_id strings from reporting-shares, not report IDs.
`--confirm`	boolean	`false`	Confirm this account mutation.
`--dry-run`	boolean	`false`	Print the request without sending it.

reporting-templates

List custom report templates, shared access and native pagination. Does not create reports or mark templates as seen.

semrush reporting-templates --help

MCP tool: reporting_templates.

Option	Type	Default
`--page`	integer	`1`
`--search`	string	`""`
`--timezone`	number	`0`

reporting-template-create

Save a custom template from an existing report. Does not generate a PDF.

semrush reporting-template-create --help

MCP tool: reporting_template_create.

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

Option	Type	Default	Description
`--report-id`	integer		Required. Saved report ID to use as the template source.
`--name`	string		Required.
`--confirm`	boolean	`false`	Confirm this account mutation.
`--dry-run`	boolean	`false`	Print the request without sending it.

reporting-template-report

Create a saved report from a custom template. Configure template placeholders before generating a PDF.

semrush reporting-template-report --help

MCP tool: reporting_template_report.

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

Option	Type	Default	Description
`--template-id`	integer		Required. Custom template ID from reporting-templates.
`--name`	string		Required.
`--confirm`	boolean	`false`	Confirm this account mutation.
`--dry-run`	boolean	`false`	Print the request without sending it.

reporting-template-delete

Delete a custom template without deleting reports created from it.

semrush reporting-template-delete --help

MCP tool: reporting_template_delete.

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

Option	Type	Default	Description
`--template-id`	integer		Required. Exact custom template ID, not a saved report ID.
`--confirm`	boolean	`false`	Confirm this account mutation.
`--dry-run`	boolean	`false`	Print the request without sending it.

reporting-template-restore

Restore a previously deleted custom template using its exact template ID.

semrush reporting-template-restore --help

MCP tool: reporting_template_restore.

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

Option	Type	Default	Description
`--template-id`	integer		Required. Exact custom template ID, not a saved report ID.
`--confirm`	boolean	`false`	Confirm this account mutation.
`--dry-run`	boolean	`false`	Print the request without sending it.

Share a custom report template and send access notifications to the specified email addresses.

semrush reporting-template-share --help

MCP tool: reporting_template_share.

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

Option	Type	Default	Description
`--template-id`	integer		Required. Custom template ID from reporting-templates.
`--emails`	array		Required. Recipients who will receive access and sharing notifications.
`--confirm`	boolean	`false`	Confirm this account mutation.
`--dry-run`	boolean	`false`	Print the request without sending it.

Revoke custom template access for the specified email addresses.

semrush reporting-template-share-revoke --help

MCP tool: reporting_template_share_revoke.

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

Option	Type	Default	Description
`--template-id`	integer		Required. Custom template ID from reporting-templates.
`--emails`	array		Required. Recipients whose custom template access will be revoked.
`--confirm`	boolean	`false`	Confirm this account mutation.
`--dry-run`	boolean	`false`	Print the request without sending it.

reporting-task-delete

Delete one generated PDF from a saved report, preserving the report, other generations and local downloads.

semrush reporting-task-delete --help

MCP tool: reporting_task_delete.

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

Option	Type	Default	Description
`--report-id`	integer		Required.
`--task-id`	string		Required. Exact task ID from reporting-tasks. Deletes only this PDF generation.
`--confirm`	boolean	`false`	Confirm this account mutation.
`--dry-run`	boolean	`false`	Print the request without sending it.

reporting-restore

Restore a deleted saved report while Semrush still retains it, preserving its saved settings and remaining PDF generations.

semrush reporting-restore --help

MCP tool: reporting_restore.

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

Option	Type	Default	Description
`--report-id`	integer		Required.
`--confirm`	boolean	`false`	Confirm restoring the report and its saved delivery settings.
`--dry-run`	boolean	`false`	Print the request without sending it.

My Reports

reporting-overview

reporting-create

reporting-get

reporting-save

reporting-clone

reporting-tasks

reporting-generate

reporting-download

reporting-delete

reporting-shares

reporting-templates

reporting-template-create

reporting-template-report

reporting-template-delete

reporting-template-restore

reporting-task-delete

reporting-restore

On this page

My Reports

reporting-overviewCopy Anchor Link

reporting-createCopy Anchor Link

reporting-getCopy Anchor Link

reporting-saveCopy Anchor Link

reporting-cloneCopy Anchor Link

reporting-tasksCopy Anchor Link

reporting-generateCopy Anchor Link

reporting-downloadCopy Anchor Link

reporting-deleteCopy Anchor Link

reporting-sharesCopy Anchor Link

reporting-shareCopy Anchor Link

reporting-share-set-roleCopy Anchor Link

reporting-share-revokeCopy Anchor Link

reporting-templatesCopy Anchor Link

reporting-template-createCopy Anchor Link

reporting-template-reportCopy Anchor Link

reporting-template-deleteCopy Anchor Link

reporting-template-restoreCopy Anchor Link

reporting-template-shareCopy Anchor Link

reporting-template-share-revokeCopy Anchor Link

reporting-task-deleteCopy Anchor Link

reporting-restoreCopy Anchor Link

On this page

reporting-overview

reporting-create

reporting-get

reporting-save

reporting-clone

reporting-tasks

reporting-generate

reporting-download

reporting-delete

reporting-shares

reporting-share

reporting-share-set-role

reporting-share-revoke

reporting-templates

reporting-template-create

reporting-template-report

reporting-template-delete

reporting-template-restore

reporting-template-share

reporting-template-share-revoke

reporting-task-delete

reporting-restore