edit/positions_2/checker/go

Method description

Use the method to check keyword rankings.

This method is not applicable to the archived projects.

Method parameters

Parameter Type Description Default
Mandatory
filters array filters
of projects
Filter projects by
Additional
regions_indexes array(int) Region indexes (filter)
folders_ids array(int) Folders ids (filter)
folders_ids_depth boolean Check subfolders when filter by folder ID applied 0
groups_ids array(int) Groups ids (filter)
do_snapshots enum(0, 2, 3, 5, 9)

SERP Snapshot depth (overlaps a similar value in the project settings).

Available values:

  • 0 - do not collect snapshots
  • 2 - TOP-20 SERP Snapshots
  • 3 - TOP-30 SERP Snapshots
  • 5 - TOP-50 SERP Snapshots
  • 9 - TOP-100 SERP Snapshots
Value in the project settings
keyword_id int

Keyword ID (filter)

  • not applicable to the bulk project rankings update
  • regions_indexes is mandatory
  • ignores groups_ids
  • ignores do_snapshots

Посмотреть в API Explorer

Returned data

Parameter Type Description
result (object)
projectsIds array(int) IDs of projects submitted to Rank tracker