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

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

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

GET:

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

POST:

1. requests — массив запросов для проверки;
2. lr — регион по Яндексу;
3. search_system — поисковая система;
4. deep — глубина анализа выдачи;
5. geo — геозависимость и локализация;
6. vital_answer — наличие витального ответа;
7. comm — коммерциализация;
8. intent — интент;
9. gruppirovka — группировка (кластеризация);
10. gruppirovka_method — метод группировки;
11. gruppirovka_user_grouping_pow — степень группировки;
12. gruppirovka_generate_url — формировать URL из названия группы;
13. gruppirovka_home_pages — определить число главных страниц по запросу;
14. gruppirovka_exclude_data — исключить витальные ответы, новости и агрегаторы;
15. gruppirovka_exclude_domains_chbx — исключить свой список доменов;
16. gruppirovka_exclude_domains — список доменов;
17. site_type — типы сайтов в выдаче;
18. competition — конкуренция по запросу;
19. wordstat_advanced — частоты запросов;
20. positions — позиции и релевантные страницы;
21. positions_url — ваш сайт;
22. positions_force_check_relevant — определить релевантные URL для запросов, которые ниже ТОП-100;
23. positions_subdomains — учитывать поддомены;
24. positions_ss[] — поисковые системы;
25. positions_lrs[] — регионы;
26. delete_none_target_queries — удалить нецелевые запросы;
27. del_implicit_duplicates — удалить неявные дубли;
28. del_geo — удалить c геозависимостью;
29. del_geo_type — тип геозависимости;
30. del_local — удалить с локализацией;
31. del_local_less — ниже;
32. del_local_more — выше;
33. del_commer — удалить с коммерциализацией;
34. del_commer_less — ниже;
35. del_commer_more — выше;
36. del_frequency_ratio — удалить с соотношением частот;
37. del_frequency_ratio_less — ниже;
38. del_frequency_ratio_more — выше;
39. del_frequency — удалять с нулевой частотностью;
40. exceptions_words_filter — указать список стоп-слов;
41. exceptions_words — список стоп-слов;

ДОПУСТИМЫЕ ЗНАЧАНИЯ ПАРАМЕТРОВ:

1. requests — массив запросов до 10000 штук;
2. lr — код региона в Яндексе из списка, например, Москва — 213 (необязательный, по умолчанию 213);
3. deep — целое число, значения 10, 25 и 50 (по умолчанию 25);
4. search_system — целое число,  1 (Яндекс) или 2 (Google) (по умлочанию 1);
5. geo — 1 или null (необязательный, по умолчанию null);
6. vital_answer — 1 или null (необязательный, по умолчанию null);
7. comm — 1 или null (необязательный, по умолчанию null);
8. intent — 1 или null (необязательный, по умолчанию null);
9. gruppirovka — 1 или null (необязательный, по умолчанию null);
10. gruppirovka_method — строка, hard (сильная связь), middle (средняя связь) или soft (слабая связь) (необязательный, по умолчанию hard);
11. gruppirovka_user_grouping_pow — число от 1 до 10 (необязательный, по умолчанию 3);
12. gruppirovka_generate_url — 1 или null (необязательный, по умолчанию null);
13. gruppirovka_home_pages — 1 или null (необязательный, по умолчанию null);
14. gruppirovka_exclude_data — 1 или null (необязательный, по умолчанию null);
15. gruppirovka_exclude_domains_chbx — 1 или null (необязательный, по умолчанию null);
16. gruppirovka_exclude_domains — массив доменов до 100 штук;
17. site_type — 1 или null (необязательный, по умолчанию null);
18. competition — 1 или null (необязательный, по умолчанию null);
19. wordstat_advanced — 1 или null (необязательный, по умолчанию null);
20. positions — 1 или null (необязательный, по умолчанию null);
21. positions_url — строка url;
22. positions_force_check_relevant — 1 или null (необязательный, по умолчанию null);
23. positions_subdomains — 1 или null (необязательный, по умолчанию null);
24. positions_ss[] — массив строк из списка: yandex-xml (Яндекс), yandex-mobile (Яндекс мобильный), google-desktop (Google десктоп), google-mobile (Google мобильный). До 6 штук, значения могут повторяться;
25. positions_lrs[] — массив кодов регионов в Яндексе из списка, например, Москва — 213. До 6 штук, значения могут повторяться;
26. delete_none_target_queries — 1 или null (необязательный, по умолчанию null);
27. del_implicit_duplicates — 1 или null (необязательный, по умолчанию null);
28. del_geo — 1 или null (необязательный, по умолчанию null);
29. del_geo_type — строка, with (геозависимые) или without (геонезависимые);
30. del_local — 1 или null (необязательный, по умолчанию null); 
31. del_local_less — число;
32. del_local_more — число;
33. del_commer — 1 или null (необязательный, по умолчанию null); 
34. del_commer_less — число;
35. del_commer_more — число;
36. del_frequency_ratio — 1 или null (необязательный, по умолчанию null); 
37. del_frequency_ratio_less — число;
38. del_frequency_ratio_more — число;
39. del_frequency — 1 или null (необязательный, по умолчанию null); 
40. exceptions_words_filter — 1 или null (необязательный, по умолчанию null);
41. exceptions_words — массив слов до 1000 штук;

Для запуска инструмента должна быть выбрана минимум одна из доступных проверок: geo, vital_answer, comm, intent, gruppirovka, site_type, competition, wordstat_advanced или positions.

Возвращает JSON:

В случае запроса на обработку:

{"report_id":"номер запроса"}

В случае запроса обработки:

• request — данные запроса.
• response — ответ инструмента:
  • result — массив запросов с данными:
    • query — запрос.
    • group — группа запроса.
    • generated_url — относительная ссылка.
    • ws_exact — точная частота запроса.
    • ws_overall — общая частота запроса.
    • morda_count — число главных страниц в выдаче.
    • geo — геозависимость, true/false.
    • local_pow — степень локализации выдачи.
    • com — коммерциализация.
    • vital — наличие витального ответа, true/false.
    • rev — интенты пользователя по запросу: отзывы.
    • media — интенты пользователя по запросу: фото и видео.
    • lex — интенты пользователя по запросу: словари и определения.
    • music — интенты пользователя по запросу: музыка.
    • trav — интенты пользователя по запросу: путешествия.
    • thematic_words — массив слов, задающих тематику.
    • classified — массив типов сайтов и значений.
    • competition — конкуренция по запросу (баллов).
    • rel_url — релевантный URL.
    • site_pos — позиция сайта.
    • top_url — массив топ-10 сайтов конкурентов.
    • Для каждой пары поисковая система и регион:
      • position — позиция.
      • relevant_URL — релевантный URL.
  • dictionary — дополнительные данные:
    • classified — массив категорий типов сайтов.
    • prep_slugs — массив названий поисковых систем и регионов.
• 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} — неверно задано название метода;