Rankings tracking methods


Operation GET parameters POST parameters Response
Start rankings tracking &oper=edit&module=mod_keywords
&func=parse_task
id {result, message, error}
Start filtered rankings tracking &oper=edit&module=mod_keywords
&func=parse_task
id, searcher, region_key, region_lang, group_id, region_device {result, message, error}
Start rankings tracking of random keywords &oper=edit&module=mod_keywords
&func=parse_one_task
phrase_id, project_id, searcher, region_key, region_lang, region_device, id {result, message, error}

Description of POST parameters:

  • id – project id;
  • searcher – selected SE:
    • 0 - Yandex, location-based;
    • 1 - Google, location-based;
    • 2 - Mail
    • 3 - Sputnik
    • 4 - Youtube
    • 5 - Bing
    • 6 - Yahoo
    • -2 - Searchers comparison
  • region_key – location number (search results location code "-1", regions comparison "-2");
  • region_lang – language code of search results (by default "en");
  • group_id – id of keyword group ("-1" – all groups);
  • region_device – device type:
    • 0 - PC
    • 1 - tablet
    • 2 - smartphone
  • phrase_id – keyword id;
  • project_id – project id;

Response description:

  • result – status of rankings tracking:
    • 0 - rank tracking failed to start due to an error;
    • 1 - rankings tracking started;
  • message – error message in Unicode Entities format;
  • error – error status:
    • true - error
    • false - no error

Start rankings tracking (project id XXX):
https://api.topvisor.ru/?api_key=Your_Key&oper=edit&module=mod_keywords&func=parse_task
&post[id]=XXX

Start filtered rankings tracking (group id X, project id XXX, SE - Google, selected region - Chicago):
https://api.topvisor.ru/?api_key=Your_Key&oper=edit&module=mod_keywords&func=parse_task
&post[id]=XXX&post[searcher]=1&post[region_key]=1000001&post[region_lang]=en&post[region_device]=0
&post[group_id]=X

Start rankings tracking of random keywords (keyword id X, project id XXX, SE - Google, selected region - Chicago):
https://api.topvisor.ru/?api_key=Your_Key&oper=edit&module=mod_keywords&func=parse_one_task
&post[project_id]=XXX&post[searcher]=1&post[region_key]=1000001&post[region_lang]=en&post[region_device]=0
&post[phrase_id]=X&post[id]=XXX