edit/positions_2/checker/go — API Topvisor
edit/positions_2/checker/go
Last modified: 02/02/2021
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 | |
| 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, 1) | SERP Snapshot depth (overlaps a similar value in the project settings). Available values: - 0 — do not collect snapshots; - 1 — collect SERP Snapshots TOP‑100 in Yandex and the same TOP as depth in Google |
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 |
Returned data
| Parameter | Type | Description |
|---|---|---|
| result | object | |
| projectsIds | array | IDs of projects submitted to Rank tracker |