Поиск

Документация на метод "fastcheck"

API для инструмента "Быстрый чек позиций в Яндексе":
url: https://tools.pixelplus.ru/api/fastcheck

Для создания задачи необходимо сформировать POST-запрос и отправить его на URL метода с обязательными GET-параметром key и POST-параметрами описанными ниже. Система поставит задачу в очередь выполнения и вернет идентификатор отчета: report_id. Для получения результата проверки позиций необходимо отправить GET запрос с параметрами key и report_id.


Принимает параметры:
GET:

  1. key — ключ доступа к API (обязательный);
  2. report_id — Идентификатор отчета;

POST:

  1. url — URL для проверки (обязательный);
  2. lr — регион по Яндексу (обязательный);
  3. requests — массив запросов для проверки (обязательный);
  4. ismobile —  мобильная выдача (по умолчанию 0);
  5. compare -— cравнение мобильной и десктопной выдачи (по умолчанию 0);
  6. subdomains — учитывать поддомены (параметр передается, только если нужен, ожидает 1);

Максимальное количество запросов для тарифов: Эксперт, Гуру и Специальный — 1000 запросов за раз, для других тарифов — 300.

Возвращает JSON с массивом:

В случае успеха: 

{
 "top5":количество в ТОП-5,
 "top10":количество в ТОП-10,
 "top20":количество в ТОП-20,
 "top50":количество в ТОП-50,
 "queries":{
   "запрос":{
     "relevant_URL":"релевантный url",
     "full_relevant_URL":"полный релевантный url",
     "position":номер позиции,
     "name": "запрос",
     "platform":"платформа",
   }
 },
 "queries_count":количество запросов
 "comparePositionsArray": {    //(при compare равным 1)
   "запрос": {
     "name":"запрос",
     "desktopPosition":номер позиции на десктопе,
     "mobilePosition":номер позиции на мобильных устройствах,
     "difference":разница позиций,
   },
 }
}

В случае неудачи: 

  1. {"url":"Not set","requests":"Not set","lr":"Not set","code":-50} — если не задан URL, список запросов или регион для проверки;
  2. {"error":"In progress","code":50} - задание с таким идентификатором еще не выполнено;
  3. {"error":"To much requests","code":"-67"} - задано слишком много запросов; 
  4. {"error":"Not enough daily limits","code":-68} — недостаточно дневных лимитов;
  5. {"error":"Not enough hourly limits","code":-80} — недостаточно часовых лимитов;
  6. {"error":"Not enough weekly limits","code":-81} — недостаточно недельных лимитов;
  7. {"error":"Not enough monthly limits","code":-82} — недостаточно месячных лимитов;
  8. {"error":"Not enough yearly limits","code":-83} — недостаточно годовых лимитов;
  9. {"error":"access denided","code":-1} — если не задан ключ доступа;
  10. {"error":"access denided","code":-2} — если неверно задан ключ доступа;
  11. {"error":"unknown method","code":-3} — если неверно задано название метода;