Документация на метод "top10"
API для получения списка URL в ТОП-10 выдачи по запросу:
URL: https://tools.pixelplus.ru/api/top10
Принимает параметры:
Постановка задачи:
GET/POST:
- key — ключ доступа к API;
- deep — глубина выдачи;
- query — запрос для проверки (передается если проверяется только 1 запрос);
- queries — список (массив) запросов в формате JSON, передается если проверяется список запросов;
- lr — регион по Яндексу;
- ss — поисковая система, по умолчанию yandex, может принимать значения yandex, google, yandex_mobile, google_mobile.
Получение задачи:
GET/POST:
- report_id: ID задачи полученный при постановке
Возвращает JSON с массивом:
В случае успеха, при постановке задачи:
{"report_id":"1810863"} Максимальное число одновременно запущеных задач для 1 пользователя: 5.
В случае успеха, при получении задачи:
{ "status":"success", "msg":"completed", "time":"1594030789", "cost":1, "request": { "lr":"213", "queries":"ЗАПРОС", "deep":10, "ss":2 }, "response": { "response": { "deep":10, "lr":10, "ss":2, "result" { "ЗАПРОС": { "yandex_urls": [ { "url":"https:\/\/text.ru\/", "domain":"text.ru", "title":"Заголовок", "snippet":"Сниппет" , "breadcrumbs":"", // цепочка навигации, только для Yandex "rating":"5 из 5", // рейтинг, только для Yandex, если найден "is_main":1, // является ли главной страницей "is_agr":0, // является ли агрегатором } ] "google_urls": [ { "url":"https:\/\/text.ru\/", "domain":"text.ru", "title":"Заголовок", "snippet":"Сниппет" , "is_main":1, // является ли главной страницей "is_agr":0, // является ли аггрегатором } ] } } } }
В случае неудачи:
- {"error":"In progress","code":-50} — если задача с указанныи ID еще не выполнена;
- {"query":"Not set","deep":"Not set","lr":"Not set","code":-50} — если не задан запрос, глубина или регион для проверки;
- {"error":"To much deep","code":-70} — если глубина больше 50;
- {"error":"access denided","code":-1} — если не задан ключ доступа;
- {"error":"access denided","code":-2} — если неверно задан ключ доступа;
- {"error":"unknown method","code":-3} — если неверно задано название метода;
- {"error":"Not enough monthly limits","code":-82} — недостаточно месячных лимитов;