Поиск

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

API для инструмента "Анализ ТОП по ключевым показателям V2":
url: https://tools.pixelplus.ru/api/analiztopv2
 

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

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

  1. key — ключ доступа к API (обязательный);
  2. report_id — номер отчета (необязательный, для получения результата по поставленной ранее задаче);
  3. url — URL для проверки (необязательный);
  4. query — запрос для проверки (обязательный);
  5. search_system — id поисковой системы 1- Яндекс, 2- Google (необязательный, по умолчанию =1 (Яндекс));
  6. lr — регион по Яндексу (обязательный);
  7. deep — глубина анализа — может принимать значения от 1 до 20 (не обязательный);
  8. rel_url — определить релевантный URL — может принимать значение 1 (не обязательный);

POST:

  1. custom_urls — массив произвольных URL для сравнения от 1 до 20 (не обязательный). Если передан массив URL, то сравнение факторов ранжирования производится по переданному списку документов и продвигаемому URL.

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

В случае запроса на обработку:  [{"report_id":"номер запроса"}]

В случае запроса обработки (request - отправленный запрос, response - ответ инструмента): 

[{"error":"In progress", "code":50}

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

  1. {
    "request":
    {
     "query":"заданный_запрос",
     "lr":"213",
     "deep":"5",
     "url":"заданный_url",
     "user_urls":"пользовательские_url",
     "search_system":"id_поисковой_системы"
    } 
    "response":
    {
     "user_data":
      {
       "text_volume":{"words":"Количество слов","symbols":"Количество символов"},
       "query_in_text_exact":"Количество точных вхождений запроса в текст",
       "query_words_in_text_percent":[{"word":"слово","percent":1}],
       "query_words_in_title":[{"words":"слово","count":1}],
       "query_words_in_anchors":[{"word":"слово","count":10}],
       "hlwords_in_text":[{"word":"слово","percent":1},{"word":"слово2","percent":0.8}],
       "popular_words":["слово1","слово2","слово3","слово4","слово5","слово6","слово7"],
       "rel_docs_by_title":"Число релевантных документов по тегу Title",
       "title_volume":{"words":"Количество слов","symbols":"Количество символов"},
       "tcy":"тИЦ",
       "https":true или false,
       "8800":true или false,
      },
     "top_data":
      {
       "text_volume": {
       "text_volume":{"words":879,"symbols":6870},
       "query_in_text_exact":5,
       "query_words_in_text_percent":[{"word":"слово","percent":1}],
       "query_words_in_title":[{"words":"слово","count":1}],
       "query_words_in_anchors":[{"word":"слово","count":10}],
       "hlwords_in_text":[{"word":"слово","percent":1},{"word":"слово2","percent":0.8}],
       "popular_words":["слово1","слово2","слово3","слово4","слово5","слово6","слово7"],
       "rel_docs_by_title":"1338",
       "title_volume":{"words":19,"symbols":140},
       "tcy":"375",
       "8800":75 (в процентах),
       "https":true
      },
     "advanced_data":
      {
       "query":"запрос",
       "rel_url":"Релвантный url",
       "rel_url_current_position":21,
       "rel_url_age":"Возраст релевантного url",
       "reoptimization":"0%",
       "analized_url":"Проанализированный url",
       "analized_url_age":"Возраст проанализированного url"
      },
     "analized_urls":["url1","url2","url3","url4","url5"]
     }
    }

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

  1. {"error":"Not enough daily limits","code":-68} — недостаточно дневных лимитов;
  2. {"error":"Not enough hourly limits","code":-80} — недостаточно часовых лимитов;
  3. {"error":"Not enough weekly limits","code":-81} — недостаточно недельных лимитов;
  4. {"error":"Not enough monthly limits","code":-82} — недостаточно месячных лимитов;
  5. {"error":"Not enough yearly limits","code":-83} — недостаточно годовых лимитов;
  6. {"error":"access denided","code":-1} — если не задан ключ доступа;
  7. {"error":"access denided","code":-2} — если неверно задан ключ доступа;
  8. {"error":"unknown method","code":-3} — если неверно задано название метода;