В каталоге — готовые системные блоки…
\n" } }, "part": "complex", "image_url": null, "json_data": [], "time": "2026-10-06 14:41:05", "cost": 115 } } } } } } }, "/api/aiimages": { "get": { "tags": [ "aiimages" ], "operationId": "aiimages_models", "summary": "Справочник моделей / Получение результата", "description": "Нейросети, доступные вашему ключу, с допустимыми соотношениями сторон и разрешениями. Задача не ставится, лимиты не списываются. Состав меняется без предупреждения — берите значения отсюда.\n\nПовторяйте раз в 5–10 секунд, пока вместо In progress не придут ссылки. Задача, которую нейросеть не смогла выполнить, тоже завершается — с текстом в response.errors; лимиты за неё возвращаются.", "parameters": [ { "name": "models", "in": "query", "required": true, "description": "Любое непустое значение — вернуть справочник.", "schema": { "type": "integer" } }, { "name": "report_id", "in": "query", "required": false, "description": "ID задачи из ответа на постановку.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Ответ", "content": { "application/json": { "example": { "models": [ { "name": "Nano Banana Pro", "value": "nano-banana-pro", "promptLength": 0, "aspect_ratios": [ "auto", "1:1", "3:4", "4:3", "9:16", "16:9" ], "resolutions": [ "1K", "2K", "4K" ], "supports_image_input": true, "supports_multi_image_input": true, "supports_native_lang": true }, { "name": "Midjourney 6.1", "value": "midjourney --v 6.1", "promptLength": 0, "aspect_ratios": [ "1:1", "16:9", "9:16" ], "resolutions": [], "supports_image_input": true, "supports_multi_image_input": false, "supports_native_lang": false } ], "default": "nano-banana-pro" } } } } } }, "post": { "tags": [ "aiimages" ], "operationId": "aiimages_create", "summary": "Постановка задачи", "description": "Параметры — полями формы, ключ — в адресе. Файлы через API не загружаются: исходное изображение передаётся публичной ссылкой.", "parameters": [], "responses": { "200": { "description": "Ответ", "content": { "application/json": { "example": { "report_id": 18452301 } } } } }, "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "modelName": { "type": "string", "description": "value из справочника, например nano-banana-pro, gpt-image-2, flux-pro-1.1. Короткое midjourney заменяется на midjourney --v 6.0. Для удаления фона и апскейла — stableDiffusion3." }, "part": { "type": "string", "enum": [ "chat_bot", "remove_background", "upscale" ], "default": "chat_bot", "description": "Режим работы." }, "request_field": { "type": "string", "description": "Промпт: что изобразить. Обязателен при генерации, до promptLength модели (по умолчанию 2000 символов). Без ссылок и параметров вида --ar, --v — их задают modelName и aspect_ratio." }, "image_url": { "type": "string", "description": "Публичная ссылка на изображение (.png, .jpg, .jpeg, .webp): референс при генерации для моделей с supports_image_input или исходник для remove_background и upscale, где она обязательна." }, "aspect_ratio": { "type": "string", "description": "Соотношение сторон из aspect_ratios модели." }, "resolution": { "type": "string", "description": "Разрешение из resolutions модели. У моделей с выбором разрешения влияет на цену." }, "img_ref": { "type": "string", "enum": [ "img", "cref", "sref" ], "default": "img", "description": "Только Midjourney с image_url: как использовать референс." } }, "required": [ "modelName" ] } } } } } }, "/api/aivideo": { "get": { "tags": [ "aivideo" ], "operationId": "aivideo_models", "summary": "Справочник моделей / Получение результата", "description": "Нейросети, доступные вашему ключу. Задача не ставится, лимиты не списываются. Состав меняется без предупреждения — берите value отсюда.\n\nПовторяйте раз в 10–30 секунд: генерация видео занимает минуты. Задача, которую нейросеть не выполнила, тоже завершается — с success: false, лимиты за неё возвращаются.", "parameters": [ { "name": "models", "in": "query", "required": true, "description": "Любое непустое значение — вернуть справочник.", "schema": { "type": "integer" } }, { "name": "report_id", "in": "query", "required": false, "description": "ID задачи из ответа на постановку. Передавайте в адресе.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Ответ", "content": { "application/json": { "example": { "models": [ { "name": "Sora 2", "value": "sora-2", "promptLength": 0, "isVideoEdit": false }, { "name": "Runway", "value": "runway", "promptLength": 1000, "isVideoEdit": false }, { "name": "Runway Aleph", "value": "runway-aleph", "promptLength": 0, "isVideoEdit": true } ], "default": "runway" } } } } } }, "post": { "tags": [ "aivideo" ], "operationId": "aivideo_create", "summary": "Генерация видео / Редактирование видео", "description": "Ролик по описанию и, по желанию, опорному изображению. Параметры — полями формы (multipart/form-data, если загружаете файл), ключ — в адресе.\n\nПравка готового ролика по описанию. Промпт перед отправкой переводится на английский; aspect_ratio, quality и duration в этом режиме не применяются.", "parameters": [], "responses": { "200": { "description": "Ответ", "content": { "application/json": { "example": { "report_id": 18452301 } } } } }, "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "prompt": { "type": "string", "description": "Описание сцены, до promptLength модели (по умолчанию 2000 символов). Без ссылок и параметров вида --param, проходит фильтр 18+." }, "model": { "type": "string", "description": "value из справочника, например sora-2, runway, grok-imagine." }, "aspect_ratio": { "type": "string", "default": "1:1", "description": "Соотношение сторон: 1:1, 2:3, 3:2, 3:4, 4:3, 9:16, 16:9, portrait, landscape. Список общий, не все модели поддерживают все значения." }, "quality": { "type": "string", "default": "720p", "description": "Качество: 480p, 720p, 1080p или 4k. Влияет на цену." }, "duration": { "type": "integer", "description": "Длительность в секундах. Допустимые значения зависят от модели, см. таблицу ниже; недопустимое молча заменяется значением по умолчанию модели. Влияет на цену." }, "image_url": { "type": "string", "description": "Ссылка на опорное изображение (.png, .jpg, .jpeg, .webp): ролик начнётся с него. Ресурс должен быть доступен по сети, локальные адреса не принимаются." }, "upload_image": { "type": "string", "description": "Опорное изображение файлом вместо ссылки." }, "audio_description": { "type": "string", "description": "Звук или музыка — дописывается к промпту. Не передавайте пустым; модель runway звук не поддерживает." } }, "required": [ "prompt", "model" ] } } } } } }, "/api/aianswers": { "get": { "tags": [ "aianswers" ], "operationId": "aianswers_options", "summary": "Справочник регионов и языков / Получение результата", "description": "Допустимые значения ss, коды регионов lr для каждой системы и языки Google. Задачу не ставит, лимиты не тратит.\n\nПовторяйте раз в 10–30 секунд: сбор идёт порциями, большая задача занимает десятки минут.", "parameters": [ { "name": "options", "in": "query", "required": true, "description": "Любое непустое значение.", "schema": { "type": "string" } }, { "name": "report_id", "in": "query", "required": false, "description": "ID задачи из ответа на постановку.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Ответ", "content": { "application/json": { "example": { "ss": [ { "name": "Яндекс", "value": "yandex" }, { "name": "Google", "value": "google" } ], "lr": { "yandex": [ { "name": "Москва", "value": 213 }, { "name": "Санкт-Петербург", "value": 2 } ], "google": [ { "name": "Москва", "value": 213 } ] }, "languages": { "google": [ { "name": "Русский", "value": "ru" }, { "name": "Английский", "value": "en" } ] } } } } } } }, "post": { "tags": [ "aianswers" ], "operationId": "aianswers_create", "summary": "Постановка задачи", "description": "Тело — JSON-объект; поля формы метод не читает. Ключ — в адресе.", "parameters": [], "responses": { "200": { "description": "Ответ", "content": { "application/json": { "example": { "report_id": 18452301 } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "requests": { "type": "array", "description": "Поисковые запросы, от 1 до 1000." }, "searchSystems": { "type": "array", "description": "Поисковые системы и регионы, от 1 до 6 элементов. Одна система может повторяться с разными регионами." }, "url": { "type": "string", "description": "Ваш сайт: для него считается position среди источников ответа." }, "subdomains": { "type": "boolean", "default": false, "description": "true — поддомены считаются вашим сайтом: blog.example.com засчитывается за example.com." }, "collect_online": { "type": "boolean", "default": false, "description": "Только Яндекс. false — нейроответы из обычного поиска, только по популярным информационным запросам. true — режим «Поиск с Алисой»: ответ запрашивается для любых запросов, включая коммерческие и редкие. Цена — 750 вместо 4 за запрос." }, "collect_google_ai_mode": { "type": "boolean", "default": false, "description": "Только Google. true — если блока AI Overview в выдаче нет, взять ответ из вкладки «Режим ИИ». На цену не влияет." } }, "required": [ "requests", "searchSystems" ] } } } } } }, "/api/textanalyser": { "post": { "tags": [ "textanalyser" ], "operationId": "textanalyser_create", "summary": "Постановка задачи", "description": "Текст и ключевые фразы передаются в теле формы, ключ — в query.", "parameters": [], "responses": { "200": { "description": "Ответ", "content": { "application/json": { "example": { "report_id": 2617071 } } } } }, "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "text": { "type": "string", "description": "Текст для анализа. Длиннее 25 000 символов — обрезается." }, "requests": { "type": "string", "description": "Ключевые фразы, вхождения которых нужно посчитать, — по фразе на строку (или массив requests[]). Из фразы-элемента массива берутся первые 10 слов." }, "text_unique": { "type": "integer", "description": "Проверить уникальность. Включается самим наличием параметра — любое значение, даже 0; если проверка не нужна, не передавайте его." }, "text_errors": { "type": "integer", "description": "Проверить орфографию. Как и text_unique, включается наличием параметра." } }, "required": [ "text" ] } } } } }, "get": { "tags": [ "textanalyser" ], "operationId": "textanalyser_result", "summary": "Получение результата", "description": "Пока задача выполняется, приходит список с одним элементом [{\"type\": \"in_progress\", \"code\": 50, \"message\": \"In progress\"}], иногда с progress и time.", "parameters": [ { "name": "report_id", "in": "query", "required": true, "description": "ID задачи из ответа на постановку.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Ответ", "content": { "application/json": { "example": { "status": "success", "msg": "completed", "time": "1778052575", "cost": 10, "request": { "text": "Пиксель Тулс — SEO-платформа…", "requests": "пиксель тулс\nseo платформа", "text_errors": "1" }, "response": { "count_words": 12, "count_symbols_with_spaces": 78, "count_symbols_without_spaces": 67, "words_frequency": { "seo": 2, "пиксель": 1, "тулс": 1 }, "find_phrases": { "пиксель тулс": { "found": true, "count": 1, "morph": 0, "density": 8.33 } }, "words_spam": 33, "zipf": 91.18, "stopwords_percent": 16.67, "speech_parts": { "существительное": 50, "иностранное": 25, "предлог": 25 }, "text_errors": { "type": { "тулс": "Слова нет в словаре." }, "true_spell": { "тулс": "тулы" } } } } } } } } } }, "/api/textanalyseradvanced": { "post": { "tags": [ "textanalyseradvanced" ], "operationId": "text-analyser-advanced_create", "summary": "Постановка задачи", "description": "Параметры — в теле формы (массивы как multiple_urls[]=…) или JSON с заголовком Content-Type: application/json; для длинных текстов и списков запросов удобнее JSON. Ключ — в query.Флаги-опции включаются значениями 1, true, yes, on; любое другое значение и отсутствие параметра — выключено. Списки (URL, запросы, стоп-слова) можно передать массивом или строкой — по элементу на строку.", "parameters": [], "responses": { "200": { "description": "Ответ", "content": { "application/json": { "example": { "report_id": 12345678 } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "part": { "type": "string", "enum": [ "by_url", "by_text" ], "description": "Что анализируем: страницы по адресам или тексты из запроса." }, "analyse_type": { "type": "string", "enum": [ "single", "compare", "average" ], "description": "Режим анализа." }, "single_url": { "type": "string", "description": "URL вашей страницы. Обязателен для by_url в режимах single и compare; в average не используется." }, "multiple_urls": { "type": "string", "description": "URL конкурентов (compare) или страниц для усреднения (average), до 10. Строкой адреса приводятся к нижнему регистру — если в URL важен регистр, передавайте массивом." }, "single_text": { "type": "string", "description": "Ваш текст. Обязателен для by_text во всех режимах; в average входит в усреднение вместе с multiple_texts." }, "multiple_texts": { "type": "array", "description": "Для by_text: тексты конкурентов (compare) или дополнительные тексты для усреднения (average, обязательны), до 10." }, "parsing_type": { "type": "string", "enum": [ "withJs", "withoutJs", "curl" ], "default": "withoutJs", "description": "Для by_url: как получить контент страниц. Без параметра и с любым другим значением — браузер без JS." }, "brief_summary": { "type": "boolean", "default": false, "description": "Только сводка: общая статистика, популярные слова, облака релевантности. Без вхождений, LSI-слов, оценки оптимизации URL и ТЗ — быстрее, отчёт в разы меньше." }, "check_occurrences": { "type": "boolean", "default": false, "description": "Проверить вхождения запросов из check_occurrences_value; без запросов — ошибка." }, "check_occurrences_value": { "type": "string", "description": "Запросы для вхождений, до 150; в каждом не больше 7 значимых слов (без стоп-слов). Приводятся к нижнему регистру. Без них не считается оценка оптимизации URL." }, "split_occurrences": { "type": "boolean", "default": false, "description": "Считать точные формы фраз отдельно от морфологических (заполняет direct_form)." }, "check_uniqueness": { "type": "boolean", "default": false, "description": "Проверить уникальность текста каждой страницы. 50 лимитов за каждые начатые 1000 символов текста страницы." }, "check_turgenev": { "type": "boolean", "default": false, "description": "Оценить риск по «Тургеневу». 25 лимитов за страницу." }, "collect_lsi_words": { "type": "boolean", "default": false, "description": "Собрать слова из подсветки выдачи и популярные слова тематики. Работает только с check_occurrences и непустым check_occurrences_value, иначе молча игнорируется. 1 лимит за запрос. Собранные слова попадут в отчёт только с lsi_action." }, "lsi_action": { "type": "string", "enum": [ "append", "replace" ], "description": "Что сделать с собранными словами. Без параметра собранные слова в LSI-слова не попадают, хотя сбор оплачен." }, "collect_lr": { "type": "integer", "default": 213, "description": "Регион сбора слов, код lr." }, "collect_ss": { "type": "integer", "enum": [ 1, 7, 2, 8 ], "default": 1, "description": "Поисковая система для сбора слов." }, "ai_structure": { "type": "boolean", "default": false, "description": "Сгенерировать структуру страницы нейросетью — ключ recommendations.ai_structure. Только compare и average, в single игнорируется. 50 лимитов за задачу." }, "type_ai_structure": { "type": "string", "enum": [ "info", "commercial" ], "default": "info", "description": "Тип страницы для структуры." }, "exclude_numbers": { "type": "boolean", "default": false, "description": "Исключить числа из статистики и словарей." }, "seo_text_only": { "type": "boolean", "default": false, "description": "Учитывать только SEO-текст и ссылки внутри него." }, "remove_no_index_content": { "type": "boolean", "default": false, "description": "Не учитывать контент внутри <noindex>." }, "remove_alts": { "type": "boolean", "default": false, "description": "Не учитывать текст атрибутов alt." }, "custom_stop_words": { "type": "boolean", "default": false, "description": "Использовать свой список стоп-слов из stop_words вместо стандартного." }, "stop_words": { "type": "string", "description": "Свои стоп-слова; читаются только с custom_stop_words." }, "use_chars_amount": { "type": "boolean", "default": false, "description": "Считать ТЗ на фиксированный объём текста из chars_amount (сценарий with_density_by_chars в recommendations)." }, "chars_amount": { "type": "integer", "description": "Объём текста для ТЗ в символах; читается только с use_chars_amount." } }, "required": [ "part", "analyse_type" ] } } } } }, "get": { "tags": [ "textanalyseradvanced" ], "operationId": "text-analyser-advanced_summary", "summary": "Прогресс и сводка отчёта / Блок отчёта", "description": "Опрашивайте раз в 20–30 секунд. Пока задача выполняется, приходит {\"error\": \"In progress\", \"code\": 50, \"progress\": 60, \"time\": \"2026-08-03 12:00:00\"} (progress и time — когда прогресс уже известен). Готовая задача отдаёт сводку и оглавление блоков; сами блоки — следующим запросом. Опросы и чтение готового отчёта лимиты не тратят.\n\nК report_id добавляется path — путь до узла отчёта, шаги через точку. Что лежит в блоках — ниже. Ответ тоже содержит report_id, time и cost.", "parameters": [ { "name": "report_id", "in": "query", "required": true, "description": "ID задачи из ответа на постановку.", "schema": { "type": "integer" } }, { "name": "path", "in": "query", "required": false, "description": "Путь до узла, например popular_words.freq.body. Если ключ сам содержит точку (URL конкурента), передавайте путь массивом: path[]=competitors&path[]=https://rival.ru/page/. * — весь отчёт целиком (может весить десятки мегабайт). Без параметра метод отдаёт сводку.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "Сколько ключей узла вернуть. 0 — все.", "schema": { "type": "integer", "default": 0 } }, { "name": "offset", "in": "query", "required": false, "description": "Смещение для постраничного чтения узла.", "schema": { "type": "integer", "default": 0 } }, { "name": "keys", "in": "query", "required": false, "description": "Вернуть только список ключей узла (поле keys вместо data). Включается любым непустым значением, кроме 0.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Ответ", "content": { "application/json": { "example": { "report_id": 12345678, "time": "1785751400", "cost": 3, "request": { "part": "by_url", "analyse_type": "compare", "single_url": "https://site.ru/page/", "multiple_urls": [ "https://rival1.ru/page/", "https://rival2.ru/page/" ], "check_occurrences": "on", "check_occurrences_value": [ "пластиковые окна", "купить окна" ] }, "errors": [], "summary": { "analyse_type": "compare", "user_page": { "url": "https://site.ru/page/", "title": "Пластиковые окна в Москве", "description": "Пластиковые окна от производителя…", "h1": "Пластиковые окна", "general_statistics": { "character_count": 12000, "character_count_text": 9000, "character_count_links": 3000, "word_count": 1800, "word_count_text": 1300, "word_count_links": 500, "uniqueness": null, "spam_score": 43, "stop_words_percentage": 28.4, "zipf_law_quality": 78, "turgenev_risk": null }, "url_optimization_estimation": 55 }, "competitors_benchmark": { "min": { "word_count": 1500, "spam_score": 38 }, "max": { "word_count": 2600, "spam_score": 51 }, "average": { "word_count": 2050, "spam_score": 44.5 } }, "competitors": { "https://rival1.ru/page/": { "url": "https://rival1.ru/page/", "title": "Окна ПВХ", "description": "…", "h1": "…", "general_statistics": { "word_count": 2600, "spam_score": 51 }, "url_optimization_estimation": 80 } } }, "blocks": { "users": { "items": 2, "keys": [ "general_statistics", "additional" ] }, "competitors": { "items": 2, "keys": [ "https://rival1.ru/page/", "https://rival2.ru/page/" ] }, "popular_words": { "items": 2, "keys": [ "freq", "dens" ] }, "clouds": { "items": 2, "keys": [ "usersPage", "competitorsPage" ] }, "text_and_links": { "items": 4, "keys": [ "occurrences", "all_words", "lsi_words", "stop_words" ] }, "headings_and_metatags": { "items": 2, "keys": [ "occurrences", "all_words" ] }, "url_optimization_estimation": { "items": 3, "keys": [ "https://site.ru/page/", "https://rival1.ru/page/", "https://rival2.ru/page/" ] }, "recommendations": { "items": 2, "keys": [ "text_and_links", "headings_and_metatags" ] } } } } } } } } }, "/api/iiotvety": { "get": { "tags": [ "iiotvety" ], "operationId": "iiotvety_options", "summary": "Справочник регионов и языков / Получение результата", "description": "Допустимые значения ss, коды регионов lr для каждой системы и языки Google. Задачу не ставит, лимиты не тратит.\n\nПовторяйте раз в 10–30 секунд: сбор идёт порциями, большая задача занимает десятки минут.", "parameters": [ { "name": "options", "in": "query", "required": true, "description": "Любое непустое значение.", "schema": { "type": "string" } }, { "name": "report_id", "in": "query", "required": false, "description": "ID задачи из ответа на постановку.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Ответ", "content": { "application/json": { "example": { "ss": [ { "name": "Яндекс", "value": "yandex" }, { "name": "Google", "value": "google" } ], "lr": { "yandex": [ { "name": "Москва", "value": 213 }, { "name": "Санкт-Петербург", "value": 2 } ], "google": [ { "name": "Москва", "value": 213 } ] }, "languages": { "google": [ { "name": "Русский", "value": "ru" }, { "name": "Английский", "value": "en" } ] } } } } } } }, "post": { "tags": [ "iiotvety" ], "operationId": "iiotvety_create", "summary": "Постановка задачи", "description": "Тело — JSON-объект; поля формы метод не читает. Ключ — в адресе.", "parameters": [], "responses": { "200": { "description": "Ответ", "content": { "application/json": { "example": { "report_id": 18452301 } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "requests": { "type": "array", "description": "Поисковые запросы, от 1 до 1000." }, "searchSystems": { "type": "array", "description": "Поисковые системы и регионы, от 1 до 6 элементов. Одна система может повторяться с разными регионами." }, "url": { "type": "string", "description": "Ваш сайт: для него считается position среди источников ответа." }, "subdomains": { "type": "boolean", "default": false, "description": "true — поддомены считаются вашим сайтом: blog.example.com засчитывается за example.com." }, "collect_online": { "type": "boolean", "default": false, "description": "Только Яндекс. false — нейроответы из обычного поиска, только по популярным информационным запросам. true — режим «Поиск с Алисой»: ответ запрашивается для любых запросов, включая коммерческие и редкие. Цена — 750 вместо 4 за запрос." }, "collect_google_ai_mode": { "type": "boolean", "default": false, "description": "Только Google. true — если блока AI Overview в выдаче нет, взять ответ из вкладки «Режим ИИ». На цену не влияет." } }, "required": [ "requests", "searchSystems" ] } } } } } }, "/api/serp/yandex/searchAndContext/set": { "post": { "tags": [ "serp-yandex-search-and-context" ], "operationId": "serp-yandex-search-and-context_set", "summary": "Постановка задачи: органика и реклама", "description": "Ставит задачу и сразу списывает лимиты: 2 за каждый уникальный запрос, независимо от deep, is_mobile и ads_only. Параметры можно передать и в query.", "parameters": [], "responses": { "200": { "description": "Ответ", "content": { "application/json": { "example": { "task_id": 18452301 } } } } }, "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "keywords": { "type": "array", "description": "Запросы: строка, по запросу на строку, или массив keywords[]. Пустые строки и дубли отбрасываются. До 15 000 запросов." }, "region": { "type": "integer", "description": "Регион Яндекса (lr), например 213 — Москва. Только из справочника serp/regions/get." }, "deep": { "type": "integer", "default": 50, "description": "Сколько результатов органической выдачи собирать по запросу. На стоимость не влияет." }, "is_mobile": { "type": "integer", "enum": [ 0, 1 ], "default": 0, "description": "Мобильная выдача вместо десктопной." }, "ads_only": { "type": "integer", "enum": [ 0, 1 ], "default": 0, "description": "Собрать только рекламу, без органической выдачи. Цена та же." } }, "required": [ "keywords", "region" ] } } } } } }, "/api/serp/yandex/set": { "post": { "tags": [ "serp-yandex-search-and-context" ], "operationId": "serp-yandex-search-and-context_set-organic", "summary": "Постановка задачи: только органика", "description": "То же без сбора рекламы — за 1 лимит на запрос; рекламные блоки в результате пустые. Параметры, ответ, статус и получение результата — как у searchAndContext/set, кроме ads_only.", "parameters": [], "responses": { "200": { "description": "Ответ", "content": { "application/json": { "example": { "task_id": 18452302 } } } } }, "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "keywords": { "type": "array", "description": "Запросы: строка, по запросу на строку, или массив keywords[]. Пустые строки и дубли отбрасываются. До 15 000 запросов." }, "region": { "type": "integer", "description": "Регион Яндекса (lr), например 213 — Москва. Только из справочника serp/regions/get." }, "deep": { "type": "integer", "default": 50, "description": "Сколько результатов органической выдачи собирать по запросу. На стоимость не влияет." }, "is_mobile": { "type": "integer", "enum": [ 0, 1 ], "default": 0, "description": "Мобильная выдача вместо десктопной." } }, "required": [ "keywords", "region" ] } } } } } }, "/api/serp/yandex/status": { "post": { "tags": [ "serp-yandex-search-and-context" ], "operationId": "serp-yandex-search-and-context_status", "summary": "Готовность задачи", "description": "Опрашивайте раз в 5–10 секунд, пока progress не станет 100. Сразу после постановки может прийти {\"error\": \"session is not ready\"} — задача ещё не попала в очередь, повторите запрос.", "parameters": [], "responses": { "200": { "description": "Ответ", "content": { "application/json": { "example": { "progress": 64 } } } } }, "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "task_id": { "type": "integer", "description": "ID задачи из ответа на постановку." } }, "required": [ "task_id" ] } } } } } }, "/api/serp/yandex/get": { "post": { "tags": [ "serp-yandex-search-and-context" ], "operationId": "serp-yandex-search-and-context_get", "summary": "Результат", "description": "Вызывайте, когда progress дошёл до 100. Повторные вызовы бесплатны. Большую задачу читайте частями: увеличивайте offset на limit, пока не придёт пустая выборка.", "parameters": [], "responses": { "200": { "description": "Ответ", "content": { "application/json": { "example": [ { "query": "купить смартфон", "query_id": "0", "region": 213, "is_mobile": 0, "source": "yandex", "organic": [ { "position": 1, "url": "https://www.example-shop.ru/smartfony/", "domain": "example-shop.ru", "title": "Смартфоны — купить в интернет-магазине", "snippet": "Более 2000 моделей смартфонов с доставкой…", "visible_link": "example-shop.ru › smartfony" } ], "ads_top": [ { "position": 1, "url": "https://ads.example.ru/phones/", "domain": "ads.example.ru", "title": "Смартфоны со скидкой до 30%", "snippet": "Рассрочка 0%. Доставка за 2 часа." } ], "ads_middle": [], "ads_bottom": [], "koldunshiki": { "entity_card": false, "alice_answer": false, "facts": false, "see_also": true, "map": false, "companies": true, "currency_converter": false } } ] } } } }, "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "task_id": { "type": "integer", "description": "ID задачи из ответа на постановку." }, "limit": { "type": "integer", "default": 60000, "description": "Сколько запросов отдать за вызов." }, "offset": { "type": "integer", "default": 0, "description": "Смещение для постраничного чтения." } }, "required": [ "task_id" ] } } } } } }, "/api/serp/regions/get": { "get": { "tags": [ "serp-yandex-search-and-context" ], "operationId": "serp-yandex-search-and-context_regions", "summary": "Справочник регионов", "description": "Регионы, которые принимает параметр region. Ключ не нужен — метод открыт.", "parameters": [], "responses": { "200": { "description": "Ответ", "content": { "application/json": { "example": [ { "lr": "213", "slug": "Москва" }, { "lr": "2", "slug": "Санкт-Петербург" } ] } } } } } }, "/api/geopanel": { "post": { "tags": [ "geopanel" ], "operationId": "geopanel_create", "summary": "Постановка задачи", "description": "Параметры — в теле формы или JSON (Content-Type: application/json), ключ — в query.", "parameters": [], "responses": { "200": { "description": "Ответ", "content": { "application/json": { "example": { "report_id": 2617073 } } } } }, "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "site": { "type": "string", "description": "Домен или URL сайта." }, "include_subdomains": { "type": "boolean", "default": false, "description": "Учитывать поддомены. В форме включается любым непустым значением, в том числе строкой false — чтобы не учитывать, не передавайте параметр или передайте 0." }, "models": { "type": "array", "description": "Нейросети — массив models[]. Без параметра — все доступные. Список меняется; на момент написания: yandex-alisa, google-ai-overview, openai, perplexity, alice-ai, deepseek, claude, grok, qwen, gemini. Неизвестное имя — ошибка с полным списком допустимых." } }, "required": [ "site" ] } } } } }, "get": { "tags": [ "geopanel" ], "operationId": "geopanel_result", "summary": "Получение результата", "description": "Пока задача выполняется, приходит {\"error\": \"In progress\", \"code\": 50, \"progress\": 50}.", "parameters": [ { "name": "report_id", "in": "query", "required": true, "description": "ID задачи из ответа на постановку.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Ответ", "content": { "application/json": { "example": { "response": { "prompts": [ { "prompt": { "id": 5512, "prompt": "сервисы для проверки позиций сайта" }, "neurals": [ { "neural": "yandex-alisa", "mention_position": 2, "ai_response": "Для проверки позиций подойдут…", "sources": [ { "url": "https://tools.pixelplus.ru/tools/positions", "domain": "tools.pixelplus.ru" } ], "last_check_date": "2026-09-28" } ], "last_check_date": "2026-09-28" } ], "mentions_chart": [ { "id": "all", "name": "Все", "data": [ { "x": "08.2026", "y": 12 }, { "x": "09.2026", "y": 17 } ] } ], "sources": [ { "url": "https://tools.pixelplus.ru/tools/positions", "domain": "tools.pixelplus.ru", "frequency": 9, "prompts": [] } ], "competitors": [ { "competitor": "example-seo.ru", "total_mentions_count": 6, "prompts": [] } ], "urls_found": 128, "tables_count": { "prompts": 20, "sources": 45, "competitors": 12 }, "tables_total_count": { "prompts": 20, "sources": 45, "competitors": 12 }, "csv_files": [] }, "time": "1759312800", "cost": 100 } } } } } } }, "/api/optimizationcheck": { "post": { "tags": [ "optimizationcheck" ], "operationId": "optimizationcheck_create", "summary": "Постановка задачи", "description": "Параметры — в теле формы или JSON (Content-Type: application/json), ключ — в query.", "parameters": [], "responses": { "200": { "description": "Ответ", "content": { "application/json": { "example": { "report_id": 2617072 } } } } }, "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "url", "text" ], "description": "Что анализировать." }, "queries": { "type": "array", "description": "Запросы, под которые оценивается страница: массив queries[] или строка, по запросу на строку. До 30 уникальных, без пустых строк." }, "lr": { "type": "integer", "description": "Регион Яндекса, например 213 — Москва." }, "content_fetch_method": { "type": "string", "enum": [ "browser_js", "browser_no_js" ], "description": "Как загружать страницу. Проверяется в обоих режимах — при mode=text тоже передайте любое из значений." }, "url": { "type": "string", "description": "Адрес страницы. Обязателен при mode=url." }, "title": { "type": "string", "description": "Тег Title. Обязателен при mode=text." }, "text": { "type": "string", "description": "Текст страницы. Обязателен при mode=text." } }, "required": [ "mode", "queries", "lr", "content_fetch_method" ] } } } } }, "get": { "tags": [ "optimizationcheck" ], "operationId": "optimizationcheck_result", "summary": "Получение результата", "description": "Пока задача выполняется, приходит {\"error\": \"In progress\", \"code\": 50, \"progress\": 40}.", "parameters": [ { "name": "report_id", "in": "query", "required": true, "description": "ID задачи из ответа на постановку.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Ответ", "content": { "application/json": { "example": { "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 } } } } } } }, "/api-rest/user/auth": { "post": { "tags": [ "rest-auth" ], "operationId": "rest-auth_auth", "summary": "Выпуск токенов по email и паролю", "description": "Проверяет email и пароль и выпускает пару токенов: access на час и refresh на год. Каждый вызов выпускает новую пару; прежние токены продолжают работать. Заголовок token этому методу не нужен.", "parameters": [], "responses": { "200": { "description": "Ответ", "content": { "application/json": { "example": { "status": "success", "message": "Token has been created successfully. Save your refresh-token. It will be valid for one year. If you lose your's refresh-token, you can easily recreate it via auth", "code": 201, "data": { "jwt_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjo…", "refresh_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjo…", "valid": "2026-10-06 13:00:00" }, "dt": "2026-10-06 12:00:00" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "description": "Email аккаунта Пиксель Тулс." }, "password": { "type": "string", "description": "Пароль аккаунта." } }, "required": [ "email", "password" ] } } } } } }, "/api-rest/user/refresh-token": { "post": { "tags": [ "rest-auth" ], "operationId": "rest-auth_refresh-token", "summary": "Новый access token по refresh token", "description": "Выпускает новый access token на час, не спрашивая пароль. Refresh token передаётся в заголовке refresh-token и возвращается в ответе тот же — новый не выпускается. Когда он истечёт, получите новую пару через user/auth.", "parameters": [ { "name": "refresh-token", "in": "header", "required": true, "description": "Refresh token из ответа user/auth.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ответ", "content": { "application/json": { "example": { "status": "success", "message": "Token has been updated successfully", "code": 201, "data": { "jwt_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjo…", "refresh_token": "ВАШ_REFRESH_TOKEN", "valid": "2026-10-06 13:00:00" }, "dt": "2026-10-06 12:00:00" } } } } } } }, "/api-rest/user/register": { "post": { "tags": [ "rest-auth" ], "operationId": "rest-auth_register", "summary": "Регистрация нового аккаунта", "description": "Создаёт аккаунт Пиксель Тулс и сразу выпускает для него токены — отдельно вызывать user/auth не нужно. Токены лежат на уровень глубже, чем в user/auth: в data.data.", "parameters": [], "responses": { "200": { "description": "Ответ", "content": { "application/json": { "example": { "status": "success", "message": "User has been created successfully", "code": 201, "data": { "data": { "jwt_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjo…", "refresh_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjo…", "valid": "2026-10-06 13:00:00" }, "code": 201, "status": "success", "message": "Token has been created successfully. Save your refresh-token. It will be valid for one year. If you lose your's refresh-token, you can easily recreate it via auth" }, "dt": "2026-10-06 12:00:00" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "description": "Email нового аккаунта. Нельзя: & = + < > , ' и две точки подряд." }, "password": { "type": "string", "description": "Пароль. Проверяется только, что он не пустой." }, "name": { "type": "string", "description": "Имя пользователя." }, "username": { "type": "string", "description": "Логин. Без него — не задаётся." }, "mobile_phone": { "type": "string", "description": "Телефон." } }, "required": [ "email", "password" ] } } } } } }, "/api-rest/user/delete": { "post": { "tags": [ "rest-auth" ], "operationId": "rest-auth_delete", "summary": "Отключение своего аккаунта", "description": "Отключает аккаунт, которому принадлежит токен из заголовка token. Данные не стираются, но войти больше нельзя: user/auth вернёт 418 User has been deleted. Вернуть аккаунт — через поддержку.Отключить можно только свой аккаунт: без действующего токена метод ответит 401 Token is not authorized.", "parameters": [ { "name": "token", "in": "header", "required": true, "description": "Access token из user/auth.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ответ", "content": { "application/json": { "example": { "status": "success", "message": "User has been deleted successfully", "code": 202, "data": [], "dt": "2026-10-06 12:00:00" } } } } } } }, "/api-rest/user/get-limits": { "post": { "tags": [ "rest-user" ], "operationId": "rest-user_get-limits", "summary": "Остаток лимитов", "description": "Месячный лимит пользователя: сколько всего, сколько потрачено и сколько осталось. Если тариф не даёт лимитов (базовые ограничения), все три числа — 0.", "parameters": [ { "name": "token", "in": "header", "required": true, "description": "Access token из user/auth.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ответ", "content": { "application/json": { "example": { "status": "success", "message": "User limits successfully received", "code": 200, "data": { "total": 65000, "used": 12480, "available": "52520", "month_total": 65000, "month_limits": 12480 }, "dt": "2026-10-06 12:00:00" } } } } } } }, "/api-rest/user/state/get": { "post": { "tags": [ "rest-user" ], "operationId": "rest-user_state", "summary": "Состояние аккаунта и идущие задачи", "description": "Снимок для экрана приложения: задачи инструментов, которые ждут очереди или выполняются, прогресс фоновых процессов по каждому проекту, баланс и тариф. Удобно опрашивать, чтобы показать ход проверки позиций, запущенной через positions/schedule.", "parameters": [ { "name": "token", "in": "header", "required": true, "description": "Access token из user/auth.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ответ", "content": { "application/json": { "example": { "status": "success", "message": "Request successful", "code": 200, "data": { "tools": [ { "hid": 48211903, "progress": 40, "tools_id": 12 } ], "projects": { "7002": { "positions_yandex": 35, "qdata": false, "pf": false, "intopt": false, "extopt": false, "distribution_import": false, "queries_import": false, "queries_import_spreadsheet": false, "url_group_generation": false } }, "notices": [], "user": { "id": "1001", "email": "user@example.com", "name": "Анна", "balance": "5000", "tariff": { "id": "10", "name": "Гуру", "date_end": "2026-11-21", "price": "2490" } } }, "dt": "2026-10-06 12:00:00" } } } } } } }, "/api-rest/tariff/list/get": { "post": { "tags": [ "rest-user" ], "operationId": "rest-user_tariff-list", "summary": "Тарифы и цены по периодам", "description": "Публичные тарифы и цены на 10, 30, 90 и 365 дней с учётом скидки за период и личных промо-скидок пользователя — из двух скидок берётся бо́льшая. Отсюда берут tariff_id и period для user/tariff/buy.", "parameters": [ { "name": "token", "in": "header", "required": true, "description": "Access token из user/auth.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ответ", "content": { "application/json": { "example": { "status": "success", "message": "Request successful", "code": 200, "data": { "tariffs": [ { "id": "10", "name": "Гуру", "api_access": "1", "api_limit": "3300", "support": "6", "role": "ROLE_USER_EXPERT", "limits_price": "299", "price": "2490", "date": "2020-07-13 15:20:54", "base": null, "hourly_limits": "1500", "monthly_limits": "65000" } ], "prices": { "30": { "percent": 0, "period": 30, "label": "30 дней", "tariffs_data": { "10": { "id": "10", "full_price": 2490, "end_price": 2490, "end_price_word": "рублей", "benefit": { "value": 0, "word": "рублей", "percent": 0 } } } } } }, "dt": "2026-10-06 12:00:00" } } } } } } }, "/api-rest/user/tariff/buy": { "post": { "tags": [ "rest-user" ], "operationId": "rest-user_tariff-buy", "summary": "Покупка или продление тарифа", "description": "Покупает тариф на выбранный период, при желании вместе с пакетом лимитов, и сразу списывает стоимость с баланса — так же, как кнопка «Купить» в калькуляторе тарифов. Тот же тариф продлевается, более высокий — подключается. Перейти на тариф ниже текущего нельзя.Метод списывает реальные деньги с баланса. Если денег не хватает, ничего не списывается — придёт ошибка 450; пополнить баланс можно через balance/add.", "parameters": [ { "name": "token", "in": "header", "required": true, "description": "Access token из user/auth.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ответ", "content": { "application/json": { "example": { "status": "success", "message": "Request successful", "code": 200, "data": { "tarif": "Тариф успешно продлен до 05.11.2026", "balance": "С вашего счета были списаны средства в размере: 2 490 рублей." }, "dt": "2026-10-06 12:00:00" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "tariff_id": { "type": "integer", "description": "ID тарифа из tariff/list/get. Должен быть публичным и не ниже текущего." }, "period": { "type": "integer", "enum": [ 10, 30, 90, 365 ], "default": 30, "description": "Период в днях. Любое другое значение молча заменяется на 30." }, "limits": { "type": "integer", "default": 0, "description": "Сколько лимитов докупить вместе с тарифом. Без него — только тариф." } }, "required": [ "tariff_id" ] } } } } } }, "/api-rest/projects/list": { "post": { "tags": [ "rest-projects" ], "operationId": "rest-projects_list", "summary": "Список проектов", "description": "Свои проекты и проекты с выданным доступом. По каждому — карточка, даты всех завершённых проверок позиций и счётчик ошибок технического аудита.", "parameters": [ { "name": "token", "in": "header", "required": true, "description": "Access token из user/auth.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ответ", "content": { "application/json": { "example": { "status": "success", "message": "Request successful", "code": 200, "data": [ { "project": { "id": "7002", "user_id": "1001", "domain": "example.ru", "main_mirror": "https://example.ru/", "aliases": "", "check_interval": "2", "subdomain_check": "1", "priority_sytem": "1", "frequency_type": "3", "date": "2026-03-02 11:10:43", "date_update": "2026-10-05 04:12:09", "status": "1", "name": "" }, "update": [ "2026-09-28", "2026-10-05" ], "errors": { "total_count": "64", "errors_count": "7" } } ], "dt": "2026-10-06 12:00:00" } } } } } } }, "/api-rest/projects/ss-list": { "post": { "tags": [ "rest-projects" ], "operationId": "rest-projects_ss-list", "summary": "Поисковые системы и регионы для домена", "description": "Шаг 1 создания проекта. Предлагает поисковые системы и регион по умолчанию — регион из настроек пользователя (для доменов .ua, .by, .kz — регион страны) — и отдаёт справочник систем с регионами, чтобы пользователь мог выбрать свои. Пары search_sestem.id + ключ региона идут в projects/add как search_engine и search_region.", "parameters": [ { "name": "token", "in": "header", "required": true, "description": "Access token из user/auth.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ответ", "content": { "application/json": { "example": { "status": "success", "message": "Request successful", "code": 200, "data": { "prepared_search_systems": [ { "lbl": 1, "name": "Яндекс", "region": "Москва" }, { "lbl": 3, "name": "Google", "region": "Москва" } ], "search_systems_with_regions": [ { "search_sestem": { "id": "1", "name": "Яндекс", "domain": "https://yandex.ru/", "slug": "yandex", "date": "2017-08-04 11:10:15" }, "region": { "213": "Москва", "2": "Санкт-Петербург", "54": "Екатеринбург" } } ] }, "dt": "2026-10-06 12:00:00" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "domain": { "type": "string", "description": "Домен сайта без протокола." } }, "required": [ "domain" ] } } } } } }, "/api-rest/projects/get-words": { "post": { "tags": [ "rest-projects" ], "operationId": "rest-projects_get-words", "summary": "Подбор запросов для домена", "description": "Шаг 2 создания проекта. Запросы, по которым домен уже виден в органике Яндекса, — до 500 штук, самые частотные первыми. Берётся первый регион, где у домена набралось хотя бы 200 запросов; если такого нет, придёт пустой список — тогда запросы придётся задать самим.", "parameters": [ { "name": "token", "in": "header", "required": true, "description": "Access token из user/auth.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ответ", "content": { "application/json": { "example": { "status": "success", "message": "Request successful", "code": 200, "data": [ "купить велосипед", "велосипед горный", "велосипеды москва" ], "dt": "2026-10-06 12:00:00" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "domain": { "type": "string", "description": "Домен сайта без протокола." } }, "required": [ "domain" ] } } } } } }, "/api-rest/projects/add": { "post": { "tags": [ "rest-projects" ], "operationId": "rest-projects_add", "summary": "Создание проекта", "description": "Шаг 3. Создаёт проект с настройками быстрого старта: главное зеркало определяется по Яндексу (если не найдено — https://<домен>), домен проекта берётся из зеркала, запросы добавляются в группу «Общая». Проект принадлежит владельцу токена.Массивы передавайте массивами — JSON-телом или как search-systems[0][search_engine]=1 в форме. Строку с JSON внутри поля формы метод не разбирает: запросы превратятся в одну строку, а поисковые системы не добавятся.", "parameters": [ { "name": "token", "in": "header", "required": true, "description": "Access token из user/auth.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ответ", "content": { "application/json": { "example": { "status": "success", "message": "Project successfully created", "code": 200, "data": { "project_id": 7105 }, "dt": "2026-10-06 12:00:00" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "domain": { "type": "string", "description": "Домен сайта без протокола." }, "search-systems": { "type": "array", "description": "Поисковые системы проекта: массив объектов {\"search_engine\": ID системы, \"search_region\": ID региона} из projects/ss-list. Первая становится приоритетной. Без них — Яндекс и Google, Москва." }, "key-words": { "type": "array", "description": "Запросы: массив строк (например, отредактированный ответ projects/get-words) или одна строка, где запросы разделены переводом строки. Без них проект создаётся пустым." }, "debug": { "type": "integer", "enum": [ 1 ], "description": "Проверка без создания: с 1 метод вернёт, как он понял входные данные, и проект не создаст." } }, "required": [ "domain" ] } } } } } }, "/api-rest/project/positions/get": { "post": { "tags": [ "rest-project" ], "operationId": "rest-project_positions", "summary": "Позиции запросов за период", "description": "Таблица позиций, как на вкладке «Позиции» проекта: запросы с частотой, релевантным URL и позициями в каждой поисковой системе, плюс видимость и апдейты Яндекса за период. Две формы: simple — первая и последняя проверка периода и разница, detail — позиция на каждую дату проверки.", "parameters": [ { "name": "token", "in": "header", "required": true, "description": "Access token из user/auth.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ответ", "content": { "application/json": { "example": { "status": "success", "message": "Request successful", "code": 200, "data": { "total_count": "1", "page": 1, "limit": 30, "table_type": "simple", "ss_id": "all", "from": "2026-09-28", "to": "2026-10-05", "order": "frequency", "order_type": 2, "group": false, "group_url": false, "access_type": "OWNER", "top": 10000, "change": "all", "data": { "yandex_updates": false, "visibility": { "last": 42.5, "prev": 40.1, "diff": 2.4 }, "queries": [ { "query_id": 8049495, "query": "купить велосипед", "group_id": 1, "frequency": 1250, "full_rel_url": "https://example.ru/catalog/bikes/", "full_need_url": "https://example.ru/catalog/bikes/", "search_engines": [ { "position": 4, "delta_position": 2, "search_system_id": 1, "detail": { "date1": "2026-09-28", "date2": "2026-10-05", "position1": 6, "position2": 4 }, "relevance_url": "https://example.ru/catalog/bikes/", "engine_data": { "id": 1, "name": "Яндекс (Москва)", "is_priority": 1, "region": { "id": "213", "name": "Москва" }, "engine": { "id": "1", "name": "Яндекс", "alias": "yandex" } } } ] } ] } }, "dt": "2026-10-06 12:00:00" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "project_id": { "type": "integer", "description": "ID проекта из projects/list." }, "table_type": { "type": "string", "enum": [ "simple", "detail" ], "description": "Форма ответа. По умолчанию — как выбрано в настройках проекта владельца." }, "limit": { "type": "integer", "default": 30, "description": "Запросов на странице." }, "page": { "type": "integer", "default": 1, "description": "Номер страницы." }, "order": { "type": "string", "default": "frequency", "description": "Поле сортировки." }, "order_type": { "type": "integer", "enum": [ 1, 2 ], "default": 2, "description": "Направление." }, "change": { "type": "string", "enum": [ "all", "up", "down" ], "default": "all", "description": "Только изменившиеся за период." }, "position_details": { "type": "string", "default": "all", "description": "Вход в топ или выход из него за период: in_10 — вошли в ТОП-10, out_10 — вышли; число — граница топа." }, "keyword": { "type": "string", "description": "Только запросы, содержащие эту подстроку." }, "group": { "type": "integer", "description": "ID группы запросов из keyword-groups/get." }, "group_url": { "type": "integer", "description": "ID группы URL из url-groups/get." }, "ss_id": { "type": "integer", "default": "all", "description": "Одна поисковая система проекта из search-systems/get. Без него — все." }, "top": { "type": "integer", "default": 10000, "description": "Только запросы не ниже этой позиции. 101 — только вне ТОП-100." }, "from": { "type": "string", "description": "Начало периода, ГГГГ-ММ-ДД. Передаётся вместе с to." }, "to": { "type": "string", "description": "Конец периода включительно." } }, "required": [ "project_id" ] } } } } } }, "/api-rest/project/positions/schedule": { "post": { "tags": [ "rest-project" ], "operationId": "rest-project_schedule", "summary": "Внеплановая проверка позиций", "description": "Ставит все запросы проекта в очередь на съём позиций, не дожидаясь расписания. Ход проверки виден в user/state/get — поле positions_yandex проекта. Новая проверка не запускается, пока не закончилась текущая.Проверка расходует лимиты владельца проекта — столько же, сколько плановый съём. Если их не хватает, придёт ошибка 497 с нужным количеством.", "parameters": [ { "name": "token", "in": "header", "required": true, "description": "Access token из user/auth.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ответ", "content": { "application/json": { "example": { "status": "success", "message": "Все запросы проекта example.ru поставлены в очередь на проверку позиций.", "code": 200, "data": [], "dt": "2026-10-06 12:00:00" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "project_id": { "type": "integer", "description": "ID проекта из projects/list." } }, "required": [ "project_id" ] } } } } } }, "/api-rest/project/keyword-groups/get": { "post": { "tags": [ "rest-project" ], "operationId": "rest-project_keyword-groups", "summary": "Группы запросов", "description": "Группы запросов проекта вместе с общей системной группой «Общая», постранично.", "parameters": [ { "name": "token", "in": "header", "required": true, "description": "Access token из user/auth.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ответ", "content": { "application/json": { "example": { "status": "success", "message": "Request successful", "code": 200, "data": { "total_count": 2, "page": 1, "limit": 20, "groups": [ { "id": 1, "name": "Общая", "user_id": -1, "project_id": -1, "group_order": 1, "group_type": 1, "dt_create": "0000-00-00 00:00:00", "dt_update": "2021-09-20 13:29:01" }, { "id": 140601, "name": "Велосипеды", "user_id": 1001, "project_id": 7002, "group_order": 100, "group_type": 1, "dt_create": "2026-03-02 11:15:00", "dt_update": "2026-03-02 11:15:00" } ] }, "dt": "2026-10-06 12:00:00" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "project_id": { "type": "integer", "description": "ID проекта из projects/list." }, "limit": { "type": "integer", "default": 20, "description": "Групп на странице." }, "page": { "type": "integer", "default": 1, "description": "Номер страницы." } }, "required": [ "project_id" ] } } } } } }, "/api-rest/project/url-groups/get": { "post": { "tags": [ "rest-project" ], "operationId": "rest-project_url-groups", "summary": "Группы URL", "description": "Группы целевых URL проекта, постранично. Формат ответа — как у keyword-groups/get, group_type — 3.", "parameters": [ { "name": "token", "in": "header", "required": true, "description": "Access token из user/auth.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ответ", "content": { "application/json": { "example": { "status": "success", "message": "Request successful", "code": 200, "data": { "total_count": 1, "page": 1, "limit": 20, "groups": [ { "id": 111290, "name": "example.ru/catalog", "user_id": 1001, "project_id": 7002, "group_order": 100, "group_type": 3, "dt_create": "2026-03-02 11:20:19", "dt_update": "2026-03-02 11:20:19" } ] }, "dt": "2026-10-06 12:00:00" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "project_id": { "type": "integer", "description": "ID проекта из projects/list." }, "limit": { "type": "integer", "default": 20, "description": "Групп на странице." }, "page": { "type": "integer", "default": 1, "description": "Номер страницы." } }, "required": [ "project_id" ] } } } } } }, "/api-rest/project/search-systems/get": { "post": { "tags": [ "rest-project" ], "operationId": "rest-project_search-systems", "summary": "Поисковые системы проекта", "description": "Поисковые системы и регионы, в которых проект снимает позиции. id отсюда передаётся как ss_id в фильтры позиций и сводки.", "parameters": [ { "name": "token", "in": "header", "required": true, "description": "Access token из user/auth.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ответ", "content": { "application/json": { "example": { "status": "success", "message": "Request successful", "code": 200, "data": [ { "id": 1, "name": "Яндекс (Москва)", "is_priority": 1, "region": { "id": "213", "name": "Москва" }, "engine": { "id": "1", "name": "Яндекс", "alias": "yandex" } }, { "id": 3, "name": "Google (Москва)", "is_priority": 0, "region": { "id": "213", "name": "Москва" }, "engine": { "id": "2", "name": "Google", "alias": "google" } } ], "dt": "2026-10-06 12:00:00" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "project_id": { "type": "integer", "description": "ID проекта из projects/list." } }, "required": [ "project_id" ] } } } } } }, "/api-rest/project/positions/summary/set/data": { "post": { "tags": [ "rest-project" ], "operationId": "rest-project_summary-set", "summary": "Сводка: запуск расчёта", "description": "Шаг 1 сводки по позициям — графики видимости, CTR×WS, доли запросов в ТОП-10 и ТОП-3, средней позиции и потенциала. Для каждого типа отвечает, готов ли он; неготовые ставит в фоновый расчёт. Повторяйте вызов раз в секунду-две с теми же фильтрами, пока тип не станет true, затем заберите его через summary/get/content.", "parameters": [ { "name": "token", "in": "header", "required": true, "description": "Access token из user/auth.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ответ", "content": { "application/json": { "example": { "status": "success", "message": "Request successful", "code": 200, "data": { "visibility": true, "ctrxws": false }, "dt": "2026-10-06 12:00:00" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "project_id": { "type": "integer", "description": "ID проекта из projects/list." }, "type": { "type": "array", "enum": [ "visibility", "ctrxws", "top", "top3", "positionavg", "potential" ], "description": "Какие графики нужны. Даже один тип передаётся массивом. Неизвестные типы пропускаются." }, "keyword": { "type": "string", "description": "Только запросы, содержащие эту подстроку." }, "group": { "type": "integer", "description": "ID группы запросов из keyword-groups/get." }, "group_url": { "type": "integer", "description": "ID группы URL из url-groups/get." }, "ss_id": { "type": "integer", "default": "all", "description": "Одна поисковая система проекта из search-systems/get. Без него — все." }, "top": { "type": "integer", "default": 10000, "description": "Только запросы не ниже этой позиции. 101 — только вне ТОП-100." }, "from": { "type": "string", "description": "Начало периода, ГГГГ-ММ-ДД. Передаётся вместе с to." }, "to": { "type": "string", "description": "Конец периода включительно." } }, "required": [ "project_id", "type" ] } } } } } }, "/api-rest/project/positions/summary/get/content": { "post": { "tags": [ "rest-project" ], "operationId": "rest-project_summary-get", "summary": "Сводка: готовый график", "description": "Шаг 2: данные одного графика, для которого summary/set/data вернул true. Фильтры должны совпадать с теми, что были на шаге 1, — иначе расчёт для них не найдётся.", "parameters": [ { "name": "token", "in": "header", "required": true, "description": "Access token из user/auth.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ответ", "content": { "application/json": { "example": { "status": "success", "message": "Request successful", "code": 200, "data": [ { "x": "28.09.2026", "y": 40.1 }, { "x": "05.10.2026", "y": 42.5 } ], "dt": "2026-10-06 12:00:00" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "project_id": { "type": "integer", "description": "ID проекта из projects/list." }, "content": { "type": "string", "enum": [ "visibility", "ctrxws", "top", "top3", "positionavg", "potential" ], "description": "Один тип графика." }, "keyword": { "type": "string", "description": "Только запросы, содержащие эту подстроку." }, "group": { "type": "integer", "description": "ID группы запросов из keyword-groups/get." }, "group_url": { "type": "integer", "description": "ID группы URL из url-groups/get." }, "ss_id": { "type": "integer", "default": "all", "description": "Одна поисковая система проекта из search-systems/get. Без него — все." }, "top": { "type": "integer", "default": 10000, "description": "Только запросы не ниже этой позиции. 101 — только вне ТОП-100." }, "from": { "type": "string", "description": "Начало периода, ГГГГ-ММ-ДД. Передаётся вместе с to." }, "to": { "type": "string", "description": "Конец периода включительно." } }, "required": [ "project_id", "content" ] } } } } } }, "/api-rest/project/limits/history": { "post": { "tags": [ "rest-project" ], "operationId": "rest-project_limits-history", "summary": "Расход лимитов по проектам", "description": "Сколько лимитов фактически ушло на каждый из переданных SEO-проектов за период: проверки позиций, частот, технические проверки — всё, что списывалось по проекту. Прогноз на 30 дней вперёд отдаёт project/limits-forecast.", "parameters": [ { "name": "token", "in": "header", "required": true, "description": "Access token из user/auth.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ответ", "content": { "application/json": { "example": { "status": "success", "message": "Request successful", "code": 200, "data": { "7002": { "name": "example.ru", "pid": "7002", "limits": "15210" }, "7105": { "name": "shop.example.ru", "pid": "7105", "limits": 0 } }, "dt": "2026-10-06 12:00:00" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "project": { "type": "array", "description": "ID проектов, не больше 100 за запрос." }, "dateFrom": { "type": "string", "description": "Начало периода, ДД.ММ.ГГГГ. По умолчанию — за 7 дней до dateTo." }, "dateTo": { "type": "string", "description": "Конец периода включительно, ДД.ММ.ГГГГ. По умолчанию — сегодня." } }, "required": [ "project" ] } } } } } }, "/api-rest/project/ai/limits/history": { "post": { "tags": [ "rest-project" ], "operationId": "rest-project_ai-limits-history", "summary": "Расход лимитов по GEO-проектам", "description": "То же для GEO-проектов ai.pixeltools.ru — мониторинга видимости в ИИ-ответах. ID здесь — ID GEO-проекта, а не SEO-проекта Пиксель Тулс.", "parameters": [ { "name": "token", "in": "header", "required": true, "description": "Access token из user/auth.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ответ", "content": { "application/json": { "example": { "status": "success", "message": "Request successful", "code": 200, "data": { "512": { "name": "Мой бренд", "pid": "512", "limits": "840" }, "513": { "name": "GEO-проект", "pid": "513", "limits": 0 } }, "dt": "2026-10-06 12:00:00" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "project": { "type": "array", "description": "ID GEO-проектов, не больше 100 за запрос." }, "dateFrom": { "type": "string", "description": "Начало периода, ДД.ММ.ГГГГ. По умолчанию — за 7 дней до dateTo." }, "dateTo": { "type": "string", "description": "Конец периода, ДД.ММ.ГГГГ. По умолчанию — сегодня." } }, "required": [ "project" ] } } } } } }, "/api-rest/balance/add": { "post": { "tags": [ "rest-balance" ], "operationId": "rest-balance_add", "summary": "Счёт на пополнение", "description": "Заводит неоплаченный счёт на сумму в рублях и отдаёт его номер. Если за последние 50 минут уже есть неоплаченный счёт на ту же сумму, ещё не связанный с платежом, вернётся он — повторное нажатие «Оплатить» не плодит счета. Номер передаётся в метаданные платежа ЮKassa как balance_hid.", "parameters": [ { "name": "token", "in": "header", "required": true, "description": "Access token из user/auth.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ответ", "content": { "application/json": { "example": { "status": "success", "message": "Request successful", "code": 200, "data": { "payment_id": 110616 }, "dt": "2026-10-06 12:00:00" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "sum": { "type": "integer", "description": "Сумма пополнения, целые рубли, больше нуля." } }, "required": [ "sum" ] } } } } } }, "/api-rest/balance/update": { "post": { "tags": [ "rest-balance" ], "operationId": "rest-balance_update", "summary": "Привязка платежа ЮKassa к счёту", "description": "Записывает в счёт ID созданного платежа ЮKassa — с префиксом kassa_m_payment_. Привязать можно только свой неоплаченный счёт и только один раз.", "parameters": [ { "name": "token", "in": "header", "required": true, "description": "Access token из user/auth.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ответ", "content": { "application/json": { "example": { "status": "success", "message": "Request successful", "code": 200, "data": { "id": "110616", "ext_id": "kassa_m_payment_2e8a7f3c-000f-5000-9000-1b2c3d4e5f60", "user_id": "1001", "type": "1", "sum": "1000", "date": "2026-10-06 11:58:17", "status": "2", "dt_update": "2026-10-06 12:00:00" }, "dt": "2026-10-06 12:00:00" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "payment_id": { "type": "integer", "description": "Номер счёта из balance/add." }, "external_id": { "type": "string", "description": "ID платежа в ЮKassa." } }, "required": [ "payment_id", "external_id" ] } } } } } }, "/api-rest/balance/confirm": { "post": { "tags": [ "rest-balance" ], "operationId": "rest-balance_confirm", "summary": "Подтверждение оплаты", "description": "Вызывается после оплаты. Сервер сам запрашивает платёж в ЮKassa и зачисляет деньги, только если платёж в статусе succeeded, а счёт из его метаданных (balance_hid, user_id, sum) ещё не оплачен и совпадает по пользователю и сумме. Если пользователь согласился сохранить карту, она привязывается для автоплатежей.", "parameters": [ { "name": "token", "in": "header", "required": true, "description": "Access token из user/auth.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ответ", "content": { "application/json": { "example": { "status": "success", "message": "Request successful", "code": 200, "data": [], "dt": "2026-10-06 12:00:00" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "external_id": { "type": "string", "description": "ID платежа в ЮKassa — без префикса." }, "source": { "type": "string", "enum": [ "yookassa" ], "description": "Платёжная система." } }, "required": [ "external_id", "source" ] } } } } } } } }