Поиск

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

API для проверки геозависимости и локализации запросов:
URL: https://tools.pixelplus.ru/api/geo

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

  1. key — ключ доступа к API;
  2. report_id — номер отчета с интентом;

POST:

  1. requests — массив запросов для проверки;
  2. lr — регион по Яндексу (по умолчанию 213);
  3. search_system — поисковая система, принимает yandex или google (по умолчанию yandex);
  4. intent — определить коммерциализацию запросов (принимает true / false, по умолчанию false). Коммерциализация определяется через обращение к инструменту /intent.

Возвращает JSON:
В случае запроса на обработку:  {"report_id":"номер запроса"}
В случае запроса обработки (request - отправленный запрос, response - ответ инструмента, time - время ответа инструмента, cost - расчетная стоимость в лимитах, может незначительно отличаться от фактической): 
В случае успеха:

{
    "request": {
        "queries": [
            "запрос 1"
        ],
        "lr": "100",
        "ss": "google",
        "comm": true
    },
    "response": {
        "data": {
            "запрос 1": {
                "thematic_words": [
                    "тематическое слово 1",
                    "тематическое слово 2",
                    "тематическое слово 3",
                    "тематическое слово 4",
                    "тематическое слово 5"
                ],
                "com": 90,
                "rev": 6,
                "media": 8,
                "lex": 0,
                "music": 2,
                "trav": 4
            }
        },
        "res_array": {
            "запрос 1": "Да"
        },
        "local_pow": {
            "запрос 1": 70
        }
    },
    "time": "1565343172",
    "cost": 2
}

Где:

  • requests — данные запроса для которого выполнена задача.

  • response — суммарный ответ инструмента.

  • res_array — определение геозависимости по запросам (да / нет)

  • local_pow — степень геозависимости по запросам

  • data — результат проверки коммерциализации (если запрашивалась)

  • thematic_words — тематические слова для запроса (если запрашивалась коммерциализация)

  • com — процент коммерческих результатов в ТОП-50 выдачи (если запрашивалась коммерциализация).

  • rev — процент результатов, которые содержат отзывы (если запрашивалась коммерциализация).

  • media — процент результатов фото и видео направленности (медиа) (если запрашивалась коммерциализация).

  • lex — процент словарных документов (словари) (если запрашивалась коммерциализация).

  • music — процент музыкальных результатов (скачать, слушать, mp3 и так далее) (если запрашивалась коммерциализация).

  • trav — процент результатов по тематике путешествия / отдых (если запрашивалась коммерциализация).

  • time — время ответа инструмента.

  • cost — ориентировочная стоимость инструмента, может незначительно отличаться от фактической в меньшую сторону.

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

  1. {"error":"Requests empty or is not an array","code":-50} — не заданы или неверно заданы запросы для проверки;
  2. {"error":"To many tasks from one user. Try again later.","code":-60} — превышен лимит одновременно поставленных задач для пользователя;
  3. {"error":"No requests data","code":-51} — не переданы запросы в POST;
  4. {"error":"You do not have enough limits for the processing of all requests","code":-69} - не хватает лимитов для обработки всех запросов;
  5. {"error":"Processing error","code":-104} — инструмент завершился с фатальной ошибкой;
  6. {"error":"Limits run out","code":-105} — во время выполнения инструмента закончились лимиты;
  7. {"error":"The process was canceled by a user","code":-106} — задача отменена пользователем
  8. {"error":"The process took more than 6 hours and was canceled","code":-107} — инструмент очень долго работал в фоне и мы автоматически завершили процесс;
  9. {"error":"Processing error":-125} — не предвиденная ошибка;
  10. {"error":"Access denided","code":-1} — не задан ключ доступа;
  11. {"error":"Access denided","code":-2} — неверно задан ключ доступа;
  12. {"error":"Unknown method","code":-3} — неверно задано название метода;

Пример получения данных с данного API:

$.post("https://tools.pixelplus.ru/api/geo?key=ВАШ_API_КЛЮЧ", {
    requests: ['мебель', 'офисная мебель купить']
}, function(data) {
    alert(JSON.stringify(data));
});