Инструменты · key

`optimizationcheck` Оценка качества оптимизации страницы

Оценивает, насколько страница оптимизирована под список запросов: даёт итоговую оценку в процентах и замечания по тегу Title и тексту. Страницу можно передать адресом или готовыми Title и текстом. Метод асинхронный: постановка возвращает report_id. То же в интерфейсе — оценка качества оптимизации.

Режим: асинхронный: report_id
Стоимость: 10 + 2 лимита за каждый запрос
Запросов: до 30 уникальных
Тело: форма или JSON

Постановка задачи

POST /api/optimizationcheck

Параметры — в теле формы или JSON (Content-Type: application/json), ключ — в query.

Параметры query и тело формы

mode string обязательный

Что анализировать.

url
страницу по адресу

text
переданные Title и текст
queries array обязательный

Запросы, под которые оценивается страница: массив queries[] или строка, по запросу на строку. До 30 уникальных, без пустых строк.
lr int обязательный

Регион Яндекса, например 213 — Москва.
content_fetch_method string обязательный

Как загружать страницу. Проверяется в обоих режимах — при mode=text тоже передайте любое из значений.

browser_js
браузером с выполнением JavaScript

browser_no_js
без выполнения JavaScript
url string

Адрес страницы. Обязателен при mode=url.
title string

Тег Title. Обязателен при mode=text.
text string

Текст страницы. Обязателен при mode=text.

Ответ

report_id int

ID задачи для получения результата.

POST /api/optimizationcheck

curl -X POST 'https://tools.pixelplus.ru/api/optimizationcheck?key=ВАШ_КЛЮЧ' \
  --data-urlencode 'mode=url' \
  --data-urlencode 'queries[]=мебель для офиса' \
  --data-urlencode 'queries[]=офисная мебель купить' \
  --data-urlencode 'lr=213' \
  --data-urlencode 'content_fetch_method=browser_js' \
  --data-urlencode 'url=https://example.com/catalog/office/'

<?php
$url = 'https://tools.pixelplus.ru/api/optimizationcheck?' . http_build_query([
    'key' => 'ВАШ_КЛЮЧ',
]);

$ch = curl_init($url);
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_TIMEOUT => 60,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS => http_build_query([
        'mode' => 'url',
        'queries' => [
            'мебель для офиса',
            'офисная мебель купить',
        ],
        'lr' => 213,
        'content_fetch_method' => 'browser_js',
        'url' => 'https://example.com/catalog/office/',
    ]),
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);

print_r($response);

import requests

response = requests.post(
    "https://tools.pixelplus.ru/api/optimizationcheck",
    params={
        "key": "ВАШ_КЛЮЧ",
    },
    data=[
        ("mode", "url"),
        ("queries[]", "мебель для офиса"),
        ("queries[]", "офисная мебель купить"),
        ("lr", 213),
        ("content_fetch_method", "browser_js"),
        ("url", "https://example.com/catalog/office/"),
    ],
    timeout=60,
)
print(response.json())

mode обязательный Что анализировать queries обязательный Запросы, под которые оценивается страница: массив queries[] или строка, по запросу на строку · по одному на строку lr обязательный Регион Яндекса, например 213 — Москва content_fetch_method обязательный Как загружать страницу url Адрес страницы

Запрос настоящий — выполнится с вашим ключом

Пример ответа

{
    "report_id": 2617072
}

Получение результата

GET /api/optimizationcheck

Пока задача выполняется, приходит {"error": "In progress", "code": 50, "progress": 40}.

Параметры query

report_id int обязательный

ID задачи из ответа на постановку.

Ответ

response.optimization array

Итоговая оценка и пояснение к ней — строками.
response.title_data[] array

Замечания по Title: type (error, notice и т. п.), text, data_array — данные замечания.
response.text_data[] array

Замечания по тексту, в том же формате.
response.requests_summary[] array

По запросам: query, geo — геозависимый ли, lr, ws — частота по Вордстату. Отсортированы по частоте.
response.url_summary object

Только при mode=url: server_response — код ответа, url_get_params — GET-параметры в адресе, url_linkint — внутренних ссылок на URL, url_age и url_age_in_day — возраст документа, url_len — длина адреса.
time string

Время готовности, Unix timestamp.
cost int

Стоимость задачи в лимитах.

GET /api/optimizationcheck

curl -G 'https://tools.pixelplus.ru/api/optimizationcheck' \
  --data-urlencode 'key=ВАШ_КЛЮЧ' \
  --data-urlencode 'report_id=2617072'

<?php
$url = 'https://tools.pixelplus.ru/api/optimizationcheck?' . http_build_query([
    'key' => 'ВАШ_КЛЮЧ',
    'report_id' => 2617072,
]);

$ch = curl_init($url);
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_TIMEOUT => 60,
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);

print_r($response);

import requests

response = requests.get(
    "https://tools.pixelplus.ru/api/optimizationcheck",
    params={
        "key": "ВАШ_КЛЮЧ",
        "report_id": 2617072,
    },
    timeout=60,
)
print(response.json())

report_id обязательный ID задачи из ответа на постановку

Запрос настоящий — выполнится с вашим ключом

Пример ответа

{
    "response": {
        "optimization": [
            "Текущее качество оптимизации документа — 72%"
        ],
        "title_data": [
            {
                "type": "notice",
                "text": "Длина Title в норме.",
                "data_array": []
            }
        ],
        "text_data": [
            {
                "type": "error",
                "text": "В тексте нет точного вхождения запроса «офисная мебель купить».",
                "data_array": []
            }
        ],
        "requests_summary": [
            {
                "query": "мебель для офиса",
                "geo": true,
                "lr": 213,
                "ws": 5120
            },
            {
                "query": "офисная мебель купить",
                "geo": true,
                "lr": 213,
                "ws": 1840
            }
        ],
        "url_summary": {
            "server_response": 200,
            "url_get_params": 0,
            "url_linkint": 14,
            "url_age": "2021-03-15",
            "url_age_in_day": "2 030 дней",
            "url_len": 36
        }
    },
    "time": "1734513600",
    "cost": 14
}

Ошибки

Код	Сообщение	Когда
`-100`	`tools errors`	Ошибки параметров — список сообщений в `details`: неверный `mode` или `content_fetch_method`, нет региона или он неизвестен, нет или больше 30 запросов, нет URL или Title с текстом, уже идут больше 5 задач. С `errorType: TASK_START_FAIL` — задачу не удалось поставить в очередь.
`-51`	`No requests data`	Задача поставлена не методом POST.
`-68, -80…-83`	`Not enough … limits`	Не хватает лимитов; в ответе `available` и `need`.
`50`	`In progress`	Задача ещё выполняется; `progress` — процент готовности.
`-4`	`Access denied`	`report_id` чужой или от другого инструмента.
`-104…-107, -125`	`Processing error / Limits run out / …`	Задача завершилась ошибкой — см. асинхронные задачи.
`-1, -2`	`Access denied`	Ключ не передан (HTTP 404) или не найден (HTTP 403).

Ответ с ошибкой

{
    "error": "tools errors",
    "details": [
        "Указан некоректный способ получения контента."
    ],
    "code": "-100"
}

Стоимость списывается при постановке: 10 лимитов за анализ и по 2 за каждый запрос — так, задача на 2 запроса стоит 14 лимитов. Одновременно можно держать до 5 задач.

При mode=url страница сначала проверяется на доступность: редиректы допустимы, но если адрес отвечает кодом 400 и выше или не загружается, анализ не выполняется. Проверьте страницу заранее.

optimizationcheck Оценка качества оптимизации страницы

Постановка задачи

Параметры query и тело формы

Ответ

Получение результата

Параметры query

Ответ

Ошибки

`optimizationcheck` Оценка качества оптимизации страницы