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

Запрос для проверки ответов Алисы и AI Overview в Яндексе и Google с помощью инструмента https://tools.pixelplus.ru/tools/ii-otvety.

Описание параметров:

requests — Массив поисковых запросов для проверки (обязательно). Допустимо от 1 до 1 000 запросов.

searchSystems — Массив объектов с настройками поисковых систем (обязательно). Допустимо от 1 до 6 элементов.

searchSystems[].ss — Поисковая система (обязательно). Допустимые значения: yandex, google.

searchSystems[].lr — Код региона для выбранной поисковой системы (обязательно). Например: 213 (Москва), 2 (Санкт-Петербург). Полный список регионов доступен через параметр options=true.

searchSystems[].language — Язык интерфейса (обязательно только для Google). Например: ru, en, de, fr. Полный список языков доступен через параметр options=true.

url — URL вашего сайта (необязательно). Если указан, то в результатах будет показана позиция вашего сайта в источниках AI-ответа.

subdomains — boolean, (необязательно). Учитывать поддомены при поиске сайта в источниках ИИ-ответа. Применяется только при указании параметра url. Если true — поддомены считаются частью сайта (например, blog.example.com засчитывается как попадание для example.com). По умолчанию: false.

collect_online — boolean, (необязательно). Собирать онлайн ответы Яндекс Алисы. Применяется только для поисковой системы yandex. Если false (по умолчанию) — нейроответы собираются в режиме «Поиск», только по популярным информационным запросам. Если true — в режиме «Поиск с Алисой»: запросы отправляются автоматически, включая коммерческие, длиннохвостые и новые. По умолчанию: false.

Стоимость запросов:

Стоимость рассчитывается как сумма стоимостей по каждой поисковой системе, умноженная на количество запросов:

- Яндекс — 4 единицы за 1 запрос по 1 поисковой системе.

- Google — 9 единиц за 1 запрос по 1 поисковой системе.

Пример: 10 запросов × (1 Яндекс + 1 Google) = 10 × (4 + 9) = 130 единиц.

Описание ответа при успешном завершении задачи:

request — Исходные параметры задачи: requests, url, searchSystems.

response — Результаты, сгруппированные по коду региона. Каждый регион содержит:

region_info — Название региона.

requests — Объект, где ключи — поисковые запросы. Для каждого запроса хранятся результаты по поисковым системам (yandex, google):

has_answer — Наличие AI-ответа (true / false).
answer — Текст AI-ответа или null.
position — Позиция вашего сайта среди источников AI-ответа или null, если URL не передан либо сайт не найден.
links — Массив источников AI-ответа. Каждый элемент содержит: url, domain, favicon.

time — Unix-время завершения задачи.

cost — Фактическая стоимость выполненной задачи.

Статусы при получении ответа, если задача ещё не завершена:

{"error": "In progress", "code": 50, "progress": 35} — задача выполняется, progress — процент завершения.

{"error": "Access denied", "code": -4} — задача не найдена или нет доступа.

{"error": "...", "code": "..."} — ошибка при выполнении задачи.

Ограничения:

Не более 5 одновременно запущенных задач на одного пользователя. Метод доступен только на платных тарифах.

Пример получения данных с данного API:

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

$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => 'https://tools.pixelplus.ru/api/iiotvety?key={key}',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => '',
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 0,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_HTTPHEADER => array('Content-Type: application/json'),
    CURLOPT_POSTFIELDS => json_encode(array(
        'requests' => array(
            'куда сходить',
            'куда сходить недорого',
        ),
        'url' => 'https://example.com/',
        'searchSystems' => array(
            array(
                'ss' => 'yandex',
                'lr' => '213'
            ),
            array(
                'ss' => 'google',
                'lr' => '213',
                'language' => 'ru'
            )
        )
    )),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Ответ: {"report_id": "12345678"}


2. Получение ответа (повторять до получения финального результата):

$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => 'https://tools.pixelplus.ru/api/iiotvety?key={key}&report_id=' . $reportId,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => '',
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 0,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => 'GET',
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Ответ (задача завершена):
{
    "request": {
        "requests": ["куда сходить", "куда сходить недорого"],
        "url": "https://example.com/",
        "searchSystems": [
            {"ss": "yandex", "lr": "213"},
            {"ss": "google", "lr": "213", "language": "ru"}
        ]
    },
    "response": {
        "213": {
            "region_info": "Москва",
            "requests": {
                "куда сходить": {
                    "yandex": {
                        "has_answer": true,
                        "answer": "Текст ответа Алисы...",
                        "position": 2,
                        "links": [
                            {
                                "url": "https://example.com/page/",
                                "domain": "example.com",
                                "favicon": "https://tools.pixelplus.ru/projects/shared/getfavicon/example.com"
                            }
                        ]
                    },
                    "google": {
                        "has_answer": true,
                        "answer": "Текст AI Overview...",
                        "position": null,
                        "links": []
                    }
                }
            }
        }
    },
    "time": "1748000000",
    "cost": 26
}


3. Получение опций для запроса: поисковые системы, регионы, языки:

$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => 'https://tools.pixelplus.ru/api/iiotvety?key={key}&options=true',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => '',
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 0,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => 'GET',
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Ответ:
{
    "ss": [
        {"name": "Яндекс", "value": "yandex"},
        {"name": "Google", "value": "google"}
    ],
    "lr": {
        "yandex": [{"name": "Москва", "value": "213"}, ...],
        "google": [{"name": "Москва", "value": "213"}, ...]
    },
    "languages": {
        "google": [
            {"name": "Русский", "value": "ru"},
            {"name": "English", "value": "en"},
            ...
        ]
    }
}