Change language settings to use Topvisor in your preferred language. You can select and set a preferred display language later in the Account settings. Change language settings to use Topvisor in your preferred language. ru Русский Apply

edit/schedule_2/settings

Method description

Use this method to edit additional settings of scheduled tools and reports: edit additional parameters that depend on the type parameter value.

Method parameters

Parameter Type Description Default
Mandatory
type enum Method description and available values, see here
target_id int ID of an object to get a schedule for

Method parameters of type = positions_go

Parameter Type Description Default
Additional
stop_repeated_check int boolean Do not run scheduled update if rankings were checked on demand less than 12 hours ago 0

Method parameters of type = volumes_go

Parameter Type Description Default
Additional
volumes_types array of int

Search Volume type.

Available values, see in fields and their types description

regions_keys_by_searcher_key object(searcher_key => region_key)

Sources and locations to check Search Volume

Object where parameter names are searcher_key, values are an array of region_key, and

Method parameters of type = urlsUpdater_go

Parameter Type Description Default
Additional
link_sitemap_xml string Sitemap path
regexp_sitemap string Regular expression to update Sitemap pages
regexp_audit string Regular expression to update Website SEO Audit pages
regexp_watcher string Regular expression to update Website Watcher pages
regexp_indexing string Regular expression to update Index Checker pages
max_urls_count int Max page count to update 999999

Method parameters of type = positions_report

Parameter Type Description Default
Additional
emails array of string List of Emails to send a report
with_competitors int boolean Send competition report 0
period string

Reporting period

Available values:

  • month - last month
  • week - last 10 days
  • weekly - last month (avg. pos. by week)
  • none - last 2 checks
formats string

Report format

Available values:

  • pdf
  • xlsx
  • csv
  • html
additional_fields string

Additional information in reports (pdf format)

Available values:

  • summary - summary
  • frequency - search volume
  • url - relevant pages
  • traffic - visits

Method parameters of type = watcher_report, type = indexing_report and
type = urlsUpdater_report

Parameter Type Description Default
Additional
emails array of string List of Emails to send reports
send_to_informer int boolean Send notifications to the Notification Center 0
telegram_chats_ids array of int Account IDs on Telegram


View in API explorer