topvisor_check_positions
Submit an asynchronous position check job to Topvisor for keyword ranking data. Returns project IDs immediately; results collect in the background.
Instructions
ASYNC: Submit a position check job to the Topvisor queue. Returns projectsIds immediately — actual data collection runs in the background (minutes to hours depending on queue). To monitor progress, poll topvisor_list_projects for status_positions/positions_percent fields. Read results later via topvisor_get_history once collection is complete. To preview cost first use topvisor_check_price.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"project_id": "<project_id>"
},
"name": "topvisor_check_positions"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| project_id | Yes | Project ID (converted to filter internally) | |
| regions_indexes | No | Region indexes to check (from topvisor_list_regions) | |
| folders_ids | No | ||
| folders_ids_depth | No | ||
| groups_ids | No | ||
| do_snapshots | No | 1 = also collect SERP snapshots (accessible via topvisor_get_snapshots) | |
| keyword_id | No | Check a single keyword only (requires regions_indexes; ignores groups_ids, do_snapshots) |