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

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

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

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

POST:

1. mode — режим проверки, принимает url (анализ существующей страницы по адресу) или text (анализ произвольного заголовка и текста);
2. queries — массив запросов (от 1 до 30);
3. lr — регион по Яндексу;
4. content_fetch_method — способ получения контента страницы, принимает browser_js (с исполнением JS) или browser_no_js (без исполнения JS) (обязателен при mode=url);
5. url — адрес страницы для анализа (обязателен при mode=url);
6. title — заголовок (тег Title) для анализа (обязателен при mode=text);
7. text — текст для анализа (обязателен при mode=text);

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

{
    "response": {
        "optimization": [
            "Текущее качество оптимизации документа — {оценка}%",
            "..."
        ],
        "title_data": [
            {
                "type": "error",
                "text": "...",
                "data_array": {...}
            }
        ],
        "text_data": [
            {
                "type": "notice",
                "text": "...",
                "data_array": {...}
            }
        ],
        "requests_summary": [
            {
                "query": "...",
                "geo": {true/false},
                "lr": ...,
                "ws": ...
            }, ...
        ],
        "url_summary": {
           "server_response": ...,
           "url_get_params": ...,
           "url_linkint": ...,
           "url_age": "YYYY-MM-DD",
           "url_age_in_day": ...,
           "url_len": ...,
          }
    "time": "1734513600",
    "cost": 10
}

Где:

• optimization — оценка оптимизации и текстовое пояснение к ней.

• title_data — детализация сообщений по тегу Title (type - тип сообщения, text - текст сообщения, data_array - данные сообщения).

• text_data — детализация сообщений по тексту страницы (type - тип сообщения, text - текст сообщения, data_array - данные сообщения).

• requests_summary — сводка по проверяемым запросам: query - запрос, geo - признак геозависимости запроса, lr - регион, ws - частота запроса по Wordstat.

• url_summary — результат проверки доступности и получения контента страницы (передается только при mode=url): server_response - код ответа, url_get_params - наличие GET-параметров, url_linkint - число внутренних ссылок, ведущих на URL, url_age - возраст документа, url_age_in_day - возраст документа в днях, url_len - длина URL в символах.

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

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

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

1. {"error":"No requests data","code":"-51"} — запрос отправлен не методом POST;
2. {"error":"tools errors","details":[...],"code":"-100"} — ошибки валидации запроса;
3. {"error":"tools errors","details":["To many tasks from one user. Try again later."],"code":"-100"} — превышен лимит одновременно запущенных задач для пользователя (больше 5);
4. {"error":"Not enough daily limits","code":"-68","available":0,"need":4} — не хватает лимитов для запуска задачи;
5. {"error":"Not enough daily limits","code":-68} — недостаточно дневных лимитов;
6. {"error":"Not enough hourly limits","code":-80} — недостаточно часовых лимитов;
7. {"error":"Not enough weekly limits","code":-81} — недостаточно недельных лимитов;
8. {"error":"Not enough monthly limits","code":-82} — недостаточно месячных лимитов;
9. {"error":"Not enough yearly limits","code":-83} — недостаточно годовых лимитов;
10. {"error":"No requests data","code":"-51"} — запрос отправлен не методом POST;
11. {"error":"tools errors","details":"Произошла ошибка во время установки задачи. Пожалуйста, попробуйте еще раз.","errorType":"TASK_START_FAIL","code":"-100"} — внутренняя ошибка при установке задачи в очередь;
12. {"error":"Access denided","code":-1} — не задан ключ доступа;
13. {"error":"Access denided","code":-2} — неверно задан ключ доступа;