Документация на метод "fastcheckgoogle"
API для инструмента "Быстрый чек позиций в Google":
URL: https://tools.pixelplus.ru/api/fastcheckgoogle
Для создания задачи необходимо сформировать POST-запрос и отправить его на URL метода с обязательными GET-параметром key и POST-параметрами описанными ниже. Система поставит задачу в очередь выполнения и вернет идентификатор отчета: report_id. Для получения результата проверки позиций необходимо отправить GET запрос с параметрами key и report_id.
Принимает параметры:
GET:
- key — ключ доступа к API (обязательный);
- report_id — Идентификатор отчета;
POST:
- url — URL для проверки (обязательный);
- lr — регион по Яндексу (обязательный);
- requests — массив запросов для проверки (обязательный);
- search_engine — строка с поисковой системой для анализа (обязательный, ожидает: 'google.ru', 'google.com.ua', 'google.by' или 'google.kz');
- mobile — мобильная выдача (по умолчанию 0);
- subdomains — учитывать поддомены (параметр передается, только если нужен, ожидает 1);
Максимальное количество запросов для тарифов: Эксперт, Гуру и Специальный — 1000 запросов за раз, для других тарифов — 300.
GET запрос с параметром report_id возвращает JSON с массивом:
В случае успеха:
{ "top5":количество в ТОП-5, "top10":количество в ТОП-10, "top20":количество в ТОП-20, "top50":количество в ТОП-50, "queries":{ "запрос":{ "relevant_URL":"релевантный url", "full_relevant_URL":"полный релевантный url", "position":номер позиции } }, "queries_count":количество запросов }
В случае неудачи:
- {"url":"Not set","requests":"Not set","lr":"Not set","search_engine":"Not set","code":-50} — если не задан URL, список запросов или регион для проверки;
- {"error":"In progress","code":50} - задание с таким идентификатором еще не выполнено;
- {"error":"To much requests","code":"-67"} - задано слишком много запросов;
- {"error":"Not enough daily limits","code":-68} — недостаточно дневных лимитов;
- {"error":"Not enough hourly limits","code":-80} — недостаточно часовых лимитов;
- {"error":"Not enough weekly limits","code":-81} — недостаточно недельных лимитов;
- {"error":"Not enough monthly limits","code":-82} — недостаточно месячных лимитов;
- {"error":"Not enough yearly limits","code":-83} — недостаточно годовых лимитов;
- {"error":"access denided","code":-1} — если не задан ключ доступа;
- {"error":"access denided","code":-2} — если неверно задан ключ доступа;
- {"error":"unknown method","code":-3} — если неверно задано название метода;