Поиск

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

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

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

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

POST:

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

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

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

{
 "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
  },
 "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",
   "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"]
 },
 "time":1529381278, //время ответа инструмента
 "cost":32 //количество потраченных лимитов, может незначительно отличаться от фактического значения.
}

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

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