# Viralmaxing — полная документация (для AI) Единый корпус продуктовой и developer-документации: 38 страниц. Каждая страница помечена заголовком и каноническим путём (routePath). Отвечая на вопросы, ссылайся на страницы через их routePath, например [Поиск идей](/docs/research/idea-search) или [MCP quick start](/developers/mcp/quick-start). Если ответа в корпусе нет — скажи об этом прямо, не выдумывай. --- # Что такое Viralmaxing routePath: /docs Раздел: Начало работы Описание: Найдите рабочий формат, проверьте его по аналитике и превратите в сценарий. # Что такое Viralmaxing Viralmaxing помогает выбрать тему для короткого видео, проверить её по данным и подготовить сценарий. Работа идёт в одном пространстве, поэтому аккаунты, ролики и сценарии разных клиентов не смешиваются. Хотите получить первый сценарий без обзора всех функций? Откройте [маршрут от идеи до сценария](/docs/guides/getting-started). ## Первый результат Введите задачу в строку «Спросите что угодно…» на [главной](/dashboard). Например: `найди идеи для рилсов кофейни и собери один сценарий`. Строка ассистента и быстрые действия на главной. Дальше продукт проведёт вас по трём шагам: 1. [Поиск идей](/docs/research/idea-search) находит ролики по теме, описанию или аккаунту конкурента. 2. [Аналитика](/docs/analytics/overview) показывает, какие форматы уже работают у вас. 3. [План](/docs/scenarios/plan) хранит сценарий, его статус и дату публикации. Поиск идей стоит 30 энергии. Создание сценария из ролика стоит 1 энергии. Перед платным действием Viralmaxing показывает итоговую цену. Как устроена [энергия и где смотреть баланс](/docs/reference/energy), описано отдельно. ## Выберите свой маршрут Пять гайдов повторяют реальные задачи, с которыми приходят пользователи. Каждый заканчивается проверяемым результатом. - [С чего начать](/docs/guides/getting-started): от поиска ролика до готового текста в Плане за один проход. - [Хочу понять, что залетит](/docs/guides/what-to-film): 3–5 идей для следующей съёмки из данных ниши. - [Уже снимаю, хочу расти](/docs/guides/track-results): разбор своих результатов и один эксперимент на период. - [Я бренд, продвигаю продукт](/docs/guides/beat-competitors): форматы конкурентов, адаптация и сравнение результатов. - [Я веду клиентов](/docs/guides/agency): пространство на клиента, роли и общий баланс. - [Ловлю тренды раньше](/docs/guides/catch-trends): радар свежих выбросов у нишевых авторов. ## Куда идти с конкретной задачей | Задача | Раздел | | ------------------------------ | -------------------------------------------------- | | Найти тему или формат | [Поиск идей](/docs/research/idea-search) | | Копить идеи | [Подборки](/docs/research/collections) | | Следить за конкурентами | [Аккаунты](/docs/settings/accounts) | | Вести сценарии | [План](/docs/scenarios/plan) | | Получать сигналы в Telegram | [Уведомления](/docs/analytics/notifications) | | Собирать лидов из комментариев | [Воронки в Instagram](/docs/automations/funnels) | | Задать вопрос по данным | [AI-ассистент](/docs/assistant/overview) | | Разделить клиентов и команду | [Команда и пространства](/docs/collaboration/team) | | Понять расход энергии | [Энергия и лимиты](/docs/reference/energy) | | Подключить агента, MCP или API | [Для разработчиков](/developers) | ## Термины, которые встретятся дальше - **VM Score** оценивает вирусный потенциал ролика по шкале от 0 до 100. В таблицах метрика может называться Vmax. Полный разбор метрик собран в [шпаргалке](/docs/analytics/metrics). - **Сценарий** содержит текст и материалы для съёмки. Его можно создать вручную или из найденного ролика. - **Подборка** хранит сохранённые ролики. Сохранение бесплатно и не создаёт сценарий. - **Энергия** списывается за поиск, генерацию и сбор новых данных. Просмотр уже собранной аналитики бесплатен. Если вы ведёте несколько брендов, создайте для каждого отдельное [пространство](/docs/collaboration/team). Перед поиском, импортом или работой через [MCP и API](/developers) проверьте выбранное пространство. --- # Главная routePath: /docs/getting-started/dashboard Раздел: Начало работы Описание: Начните день со сводки результатов, лучших роликов и строки ассистента. # Главная [Главная](/dashboard) отвечает на три утренних вопроса: что сработало за месяц, что сейчас в работе и что сделать следующим. Это точка старта дня, а не ещё один экран аналитики: каждый блок ведёт в свой раздел одним кликом. ## Начните со строки ассистента Строка «Спросите что угодно…» вверху принимает задачу словами: `найди идеи для рилсов кофейни и собери один сценарий`. Чипы под ней запускают частые маршруты: **«Найти идеи»**, **«Тренды»**, **«Моя аналитика»**, **«Написать сценарий»**. Как формулировать запросы, разобрано в [гайде по промптам](/docs/assistant/effective-prompts). ## Прочитайте сводку за 30 дней Блок «Ваши результаты за последние 30 дней» собирает подписчиков по всем аккаунтам, просмотры, публикации и лайки со сравнением к прошлому периоду. Ниже: динамика просмотров по дням и накопительно, «Лучшие ролики» и срез контент-плана с числом сценариев в работе и просроченными. Сводка: метрики с дельтами, динамика просмотров и лучшие ролики. Как читать эти цифры: - Процент у метрики сравнивает с предыдущими 30 днями. Метка «новое» означает, что раньше данных не было. - «Лучшие ролики» за период: кандидаты на повтор формата, проверьте их в [разборе контента](/docs/analytics/content). - Кнопка **«Вся аналитика»** открывает [полный обзор](/docs/analytics/overview) с фильтрами и распределениями. ## Если сводка пустая | Состояние | Что это значит и что нажать | | -------------------- | ------------------------------------------------------------------ | | «Подключите свой аккаунт» | своих профилей ещё нет: добавьте их в [Аккаунтах](/docs/settings/accounts) | | «Собираем данные» | аккаунт подключён, первая выгрузка занимает несколько минут | | «Данные устарели» | аккаунты давно не обновлялись: кнопка ведёт в [Обновление](/docs/analytics/refresh) | ## Ниже по странице - «Что растёт у конкурентов» показывает свежие выбросы отслеживаемых профилей: быстрый вход в [наблюдение за нишей](/docs/guides/catch-trends). - «Автоматизации» показывают результаты воронок; строка «Правило включено, но за N дней никто не написал кодовое слово» означает тишину, а не поломку. Подробнее в разделе [Воронки](/docs/automations/funnels). - «Быстрые действия» запускают типовые задачи одним кликом: добавить конкурента, найти идеи, собрать сценарий из роликов, выдать доступ команде. Следующий шаг: пройдите [маршрут от идеи до сценария](/docs/guides/getting-started), он заканчивается готовым текстом в Плане. --- # С чего начать routePath: /docs/guides/getting-started Раздел: Гайды Описание: Пройдите путь от поиска ролика до готового сценария в Плане. # С чего начать За один проход вы найдёте ролик по теме, создадите из него сценарий и откроете текст в Плане. Подключать аккаунт для поиска по слову или описанию не нужно. Минимальная стоимость прохода составляет 31 энергию. Поиск стоит 30 энергии, создание сценария из выбранного ролика стоит 1 энергии. Расшифровка и AI-правки списываются только после отдельного запуска. ## 1. Найдите ролик Откройте [Поиск идей](/explore/ideas) и выберите режим: - **«Слово или хэштег»**, если знаете точную формулировку. - **«Описание идеи»**, если хотите искать по смыслу. - Вкладка **«Конкуренты»** показывает ролики уже отслеживаемых аккаунтов. Запустите поиск и отсортируйте выдачу по вирусности. Она показывает, насколько просмотры ролика превышают размер аудитории автора. Абсолютные просмотры чаще поднимают крупные аккаунты и хуже отвечают на вопрос, повторяем ли формат. Подробности о режимах и фильтрах есть в [справочнике поиска](/docs/research/idea-search). ## 2. Создайте сценарий На карточке подходящего ролика нажмите **«Адаптировать»**. Viralmaxing создаст сценарий и добавит его в [План](/plan). Закладка на карточке выполняет другую задачу. Она бесплатно сохраняет ролик в подборку, но не создаёт сценарий. Используйте её для идей, к которым хотите вернуться позже. ## 3. Подготовьте текст Откройте карточку сценария в Плане. Там находятся текст, исходный ролик и чат с AI. ### Соберите черновик Используйте готовую расшифровку или добавьте свои тезисы. Если текста ролика нет, запустите расшифровку за 10 энергии. ### Исправляйте конкретные места Выделите хук, призыв или длинный фрагмент и попросите сократить, перефразировать или усилить его. Полное AI-переписывание стоит 3 энергии. ### Проверьте предложение AI показывает сравнение «До» и «После». Изменение попадёт в сценарий только после нажатия **«Применить»**. Готовый текст можно скопировать без таймкодов или скачать в `.txt`. Публикация из Viralmaxing не выполняется. ## Как проверить результат Проход завершён, если в [Плане](/plan) появилась карточка с вашим текстом, исходным роликом и нужным статусом. Дальше соберите ещё несколько кандидатов по маршруту [«Хочу понять, что залетит»](/docs/guides/what-to-film). Переключение пространства меняет весь рабочий контекст. Перед поиском и созданием сценария проверьте название пространства в навигации. --- # Хочу понять, что залетит routePath: /docs/guides/what-to-film Раздел: Гайды Описание: Сопоставьте сильные форматы ниши со своей аналитикой и соберите план съёмки. # Хочу понять, что залетит Этот маршрут даёт 3–5 идей для следующей съёмки. Вы сравните сильные ролики ниши со своими результатами и сохраните выбранные форматы в План. ### Открыть поиск идей Поиск по слову, хэштегу или описанию: первая сессия занимает пару минут. ## Найдите устойчивый формат 1. Откройте [Поиск идей](/explore/ideas) и задайте узкую тему. 2. Отсортируйте выдачу по **Вирусности**. 3. Сохраните 3–5 роликов, у которых одновременно сильный VM Score и высокая вирусность. Сочетание VM Score и вирусности полезнее абсолютных просмотров: крупный аккаунт может набрать много за счёт своей базы, а высокий относительный результат чаще указывает на сильный формат. Как читать обе метрики, описано в [шпаргалке метрик](/docs/analytics/metrics). Один поиск стоит 30 энергии. Расширяйте удачную сессию дополнительными ключами, прежде чем запускать новый поиск. ## Сверьте со своими результатами Откройте [Результаты](/analytics/insights) и найдите форматы, которые уже работают на ваших аккаунтах. Смотрите на топ публикаций, среднее на пост и динамику за сопоставимый период. Выберите идею, если выполняется хотя бы одно условие: - похожий формат уже даёт результат у вас; - один паттерн повторяется у нескольких авторов ниши; - ролик заметно превысил обычный уровень своего автора. Единичный хит без повторов оставьте в подборке. Он может быть исключением, а не рабочим форматом. ## Перенесите формат в План Нажмите **«Адаптировать»** на выбранных роликах. Каждый сценарий стоит 1 энергии. В [Плане](/plan) перепишите хук, аргументы и призыв под свой продукт и голос. Не копируйте исходный текст. Забирайте структуру, темп и способ раскрытия темы. Это даёт проверенную основу без дословного повторения чужого ролика. ## Повторяйте раз в неделю Один рабочий ритм выглядит так: - раз в неделю найти 3–5 кандидатов; - сравнить их со своими результатами; - добавить выбранные форматы в План; - после публикации проверить тот же период в аналитике. Следующий шаг: [разбор своих результатов](/docs/guides/track-results). --- # Уже снимаю, хочу расти routePath: /docs/guides/track-results Раздел: Гайды Описание: Проведите короткий разбор своих результатов и выберите следующий эксперимент. # Уже снимаю, хочу расти За пять минут вы определите один формат для повтора и одну гипотезу для следующего периода. Для этого нужны подключённые аккаунты с собранными публикациями. ### Открыть свои результаты Экран «Результаты» показывает первый срез сразу после подключения аккаунтов. ## Проведите короткий разбор ### Выберите период Откройте [Результаты](/analytics/insights) и задайте окно, которое соответствует вашему ритму публикаций. Сравнение строится с предыдущим периодом такой же длины. ### Найдите сильный формат В блоке «Топ публикации» сравните сортировку по просмотрам и VM Score. Высокий VM Score показывает силу формата, а просмотры показывают полученный охват. ### Проверьте источник результата Сравните аккаунты, платформы и длину роликов. Используйте среднее на пост, если в группах разное число публикаций. ### Выберите один эксперимент Запишите, что именно меняете в следующем периоде: хук, длину, тему или частоту. Назовите метрику, по которой проверите результат. ## Как читать сравнение | Состояние | Значение | | ---------- | ----------------------------------- | | «новое» | в прошлом периоде не было данных | | 0% | изменение округлилось до нуля | | дельты нет | данных нет в обоих периодах | Календарь активности показывает ритм публикаций по дням. Он не содержит почасовой аналитики и не отвечает на вопрос о лучшем времени публикации. ## Частые причины пустого результата - Новый аккаунт ещё не прошёл первый сбор. - За выбранный период нет публикаций. - В фильтре остался аккаунт или платформа без данных. - Для регулярного отчёта вы забыли заново выбрать период. Фильтры между визитами не сохраняются. Просмотр аналитики и изменение фильтров бесплатны. Перед обновлением статистики Viralmaxing показывает итоговый расход энергии. Следующий шаг: соедините свой результат с данными ниши в гайде [«Хочу понять, что залетит»](/docs/guides/what-to-film). --- # Я бренд, продвигаю продукт routePath: /docs/guides/beat-competitors Раздел: Гайды Описание: Найдите сильные форматы конкурентов, адаптируйте их и сравните результаты. # Я бренд, продвигаю продукт Этот маршрут помогает найти формат конкурента, адаптировать его под бренд и проверить результат на одинаковом периоде. ### Открыть аккаунты конкурентов Вкладка «Конкуренты» в Аккаунтах: сюда добавляются профили для наблюдения. ## Добавьте конкурентов Откройте [Аккаунты](/analytics/accounts?scope=competitor) или вкладку [Видео → Конкуренты](/analytics/posts?scope=competitor). Нажмите **«Добавить профиль»** и вставьте ссылки на Instagram, TikTok, YouTube или Facebook. Viralmaxing показывает стоимость до импорта. Один загруженный ролик стоит 1 энергии. Для Facebook действует коэффициент ×2, итог также виден до запуска. ## Найдите формат, который выбился из нормы 1. Ограничьте период последними днями или неделями. 2. Отсортируйте ролики по VM Score. 3. Проверьте множитель и вирусность у лучших кандидатов. 4. Откройте ролик и разберите хук, структуру и подачу. Множитель сравнивает ролик с обычным уровнем автора. Высокое значение помогает заметить формат, который сработал лучше его стандартного результата. ## Сравните бренд с конкурентами В [Результатах](/analytics/insights) переключайте охват вкладками «Свои» и «Конкуренты» на одинаковом периоде и одинаковых платформах. Если число публикаций отличается, сравнивайте среднее на пост, а не только общий охват. Выберите один разрыв, который можно проверить в следующем цикле. Например, длину ролика, тип хука или частоту публикаций. ## Адаптируйте ролик В карточке ролика нажмите **«Адаптировать в сценарий»**. Viralmaxing создаст сценарий в [Плане](/plan) за 1 энергии. Перепишите сюжет и аргументы под свой продукт. Сохраняйте формат, но не исходный текст. Если вы не знаете, кого отслеживать, [поиск конкурентов](/explore/discover) подберёт похожие аккаунты по нескольким источникам. Операция стоит 200 энергии за каждый источник, поэтому начните с небольшой группы точных профилей. Перед удалением конкурента проверьте подтверждение в интерфейсе. Удаление останавливает отслеживание и может убрать собранные ролики из вашей аналитики. Чтобы только остановить расходы, сначала рассмотрите ручной режим обновления. --- # Я веду клиентов routePath: /docs/guides/agency Раздел: Гайды Описание: Создайте пространство для каждого клиента и ограничьте доступ ролями. # Я веду клиентов Создайте отдельное пространство для каждого клиента. Пространство отделяет его аккаунты, ролики и сценарии. Роль определяет, что приглашённый участник может делать. Полная модель доступа, таблица ролей и восстановление ошибок описаны в разделе [Команда и пространства](/docs/collaboration/team); этот гайд проходит агентский маршрут по шагам. ### Открыть пространства Здесь создаётся отдельное пространство под каждого клиента. ## Настройте клиента ### Создайте пространство В [Пространствах](/settings/workspaces) нажмите **«Создать»** и используйте название клиента или бренда. Затем переключитесь в новое пространство. Оно появляется пустым. ### Подключите аккаунты Добавьте профили клиента в [Аккаунтах](/analytics/accounts?scope=own). Аккаунты из других пространств сюда не переносятся. ### Пригласите участника В [Команде](/settings/team) укажите email, роль и доступные пространства. Снимите доступ ко всем пространствам, если человек должен видеть только одного клиента. Клиенту обычно подходит роль Наблюдатель, внешнему автору Редактор. ### Проверьте результат Переключитесь в пространство клиента и убедитесь, что там находятся только его аккаунты. Попросите участника открыть тот же раздел под своим email. ## Покажите клиенту результат - Наблюдатель видит аналитику и План клиента сам, без пересылки скриншотов. - Экспорт из аналитики и Плана сохраняет текущие фильтры: удобно прикладывать к отчёту за период. - Уведомления в Telegram можно направить в общий чат с клиентом. Типы и настройка описаны в разделе [Уведомления](/docs/analytics/notifications). ## Учтите общий баланс Отдельного бюджета энергии на пространство нет: все участники тратят из общего [баланса владельца](/docs/reference/energy). Основной регулярный расход создаёт обновление аккаунтов, поэтому для неактивного клиента переведите расписание его профилей в ручной режим. Если команда работает через ассистента, [MCP или API](/developers), каждый вызов также действует в выбранном пространстве и тратит общий баланс. Переключение, архивирование или удаление активного пространства перезагружает страницу. Сохраните черновик и закончите текущий ответ ассистента до действия. --- # Ловлю тренды раньше routePath: /docs/guides/catch-trends Раздел: Гайды Описание: Следите за свежими выбросами у нишевых конкурентов и быстро забирайте формат в работу. # Ловлю тренды раньше Ранний сигнал появляется, когда свежий ролик заметно превышает обычный результат автора. Этот маршрут помогает увидеть такой выброс и перенести формат в План до того, как он станет массовым. ## Подготовьте радар 1. Добавьте нишевых конкурентов и включите им [регулярное обновление](/docs/analytics/refresh). 2. Откройте [Видео → Конкуренты](/analytics/posts?scope=competitor). 3. Выберите короткий период и включите фильтр новых роликов. 4. Отсортируйте выдачу по множителю или VM Score. Жёлтая или красная метка свежести означает, что данные аккаунта устарели. Сначала обновите его, иначе старый ролик может выглядеть как новый сигнал. ## Проверьте сигнал Не принимайте один большой показатель за тренд. Ищите сочетание: - ролик опубликован недавно; - множитель заметно выше обычного уровня автора; - похожая структура появляется у нескольких аккаунтов; - формат подходит вашей теме и производственным возможностям. Абсолютные просмотры крупного автора сами по себе ничего не доказывают. Маленький аккаунт с резким выбросом часто даёт более ранний сигнал. ## Заберите формат в работу Откройте ролик и нажмите **«Адаптировать в сценарий»**. Создание сценария стоит 1 энергии. В [Плане](/plan) перепишите хук, примеры и призыв под свой продукт. Если отслеживаемых аккаунтов мало, используйте [поиск конкурентов](/explore/discover). Он стоит 200 энергии за источник, поэтому выбирайте несколько точных профилей. Для регулярного мониторинга дешевле один раз настроить качественный список и расписание. Фильтр новых роликов считается от прошлого визита. Проверяйте ленту с постоянным ритмом, иначе выборка накопится и перестанет быть ранним сигналом. --- # Аналитика: обзор routePath: /docs/analytics/overview Раздел: Аналитика Описание: Сводка результатов, тренды, топ-контент и сравнение аккаунтов за период. # Аналитика: обзор Экран [Результаты](/analytics/insights) показывает сводку по подключённым аккаунтам. Здесь удобно проверить динамику за период, найти лучшие публикации и выбрать следующий эксперимент. ## Получите первый срез 1. Выберите период. 2. Оставьте только нужные платформы и аккаунты. 3. Сравните текущий период с предыдущим окном такой же длины. 4. Откройте лучший и слабый ролик для детального разбора. Если аккаунт только добавлен, аналитика появится после первого сбора. Стоимость импорта видна до запуска и зависит от числа загружаемых роликов. ## Когда какой блок смотреть - Вопрос «повторить какой формат»: откройте «Топ публикации» и сравните лидеров по просмотрам и VM Score. Расхождение сортировок само по себе подсказка: охват дал размер аккаунта или сила формата. - Вопрос «откуда результат»: распределения показывают вклад аккаунтов, платформ и длины роликов. Используйте среднее на пост при разном числе публикаций в группах. - Вопрос «держу ли ритм»: календарь активности показывает публикации по дням. Почасовой аналитики в нём нет, лучшее время публикации он не выбирает. Топ публикаций, распределения и календарь активности. ## Как читать сравнение Используйте среднее на пост, если группы опубликовали разное число роликов. Общий охват без объёма публикаций может создать ложное преимущество. Метка «новое» означает, что в прошлом периоде данных не было. Нулевая дельта может означать очень маленькое изменение, округлённое до нуля. Если данных нет в обоих окнах, сравнение не показывается. ## Если экран пустой Проверьте по порядку: - подключён ли профиль в [Аккаунтах](/docs/settings/accounts); - завершился ли первый сбор; - есть ли публикации в выбранном периоде; - не исключили ли данные фильтры; - достаточно ли у вашей роли прав на подключение аккаунтов. Фильтры и период могут сбрасываться между визитами. Для регулярного отчёта сохраняйте выбранный срез через экспорт. Следующий шаг: откройте [разбор контента](/docs/analytics/content), чтобы понять причину результата конкретного ролика. --- # Разбор контента routePath: /docs/analytics/content Раздел: Аналитика Описание: Найдите ролик по метрикам, откройте расшифровку и разберите удержание. # Разбор контента Найдите сильный и слабый ролик, затем сравните их метрики, начало и удержание. Это быстрее даёт рабочую гипотезу, чем просмотр таблицы без критерия. ## Выберите экран | Экран | Для чего нужен | | ------------------------------------- | ------------------------------------------- | | [Видео](/analytics/posts) | публикации своих аккаунтов и конкурентов; охват переключают вкладки «Свои» и «Конкуренты» | | [Глубокая аналитика](/analytics/deep) | хук и удержание по доступным данным YouTube | Если таблица пуста, проверьте выбранную вкладку, фильтры и статус первого сбора. Ролик по прямой ссылке добавляется в [Подборках](/docs/research/collections) без подключения аккаунта. ## Найдите ролики для сравнения 1. Отсортируйте таблицу по вирусности или VM Score. 2. Откройте несколько лидеров, а затем ролик с заметно более слабым результатом. 3. Сравните тему, хук, длину и реакции. 4. Сформулируйте одно отличие, которое можно проверить в следующем сценарии. Фильтры по периоду, платформе, аккаунту и группе сужают выборку. Набор колонок можно настроить под задачу и использовать в экспорте. Публикации с VM Score, вирусностью, ER и множителем. ## Разберите удержание Глубокая аналитика показывает хук, среднее удержание и кривую досмотра, когда YouTube предоставляет эти данные. Резкий спад в начале указывает на проблему с входом в тему. Поздний спад чаще связан с темпом или структурой. Сравнивайте ролики внутри одного канала. Тема, длина и аудитория влияют на удержание, поэтому универсальный порог редко объясняет причину. Хук, удержание и кривая досмотра по роликам канала. Прочерк означает, что платформа ещё не отдала показатель или данных недостаточно. Не заменяйте его нулём при экспорте и сравнении. ## Откройте карточку ролика Карточка собирает метрики, доступную расшифровку и действия. Просмотр уже собранных данных бесплатен. Новый разбор или расшифровка стоит 10 энергии. Кнопка **«Адаптировать в сценарий»** создаёт сценарий в [Плане](/docs/scenarios/plan) за 1 энергии, если этот тип ролика поддерживает действие. Используйте YouTube-удержание для диагностики, даже когда создание сценария из конкретного ролика недоступно. Удалённый на платформе ролик может остаться в аналитике, но его превью, скачивание и повторная расшифровка будут недоступны. --- # Шпаргалка метрик: как читать цифры routePath: /docs/analytics/metrics Раздел: Аналитика Описание: Как читать VM Score, вирусность, множитель, ER и сырые реакции. # Шпаргалка метрик: как читать цифры Каждая метрика отвечает на отдельный вопрос. Сравнивайте ролики одного периода и учитывайте размер аккаунта. Десять тысяч просмотров могут быть сильным результатом для небольшого автора и обычным для крупного. ## Основные метрики | Метрика | Что показывает | Когда использовать | | ---------- | ---------------------------------------------- | ------------------------------ | | VM Score | вирусный потенциал ролика по шкале от 0 до 100 | первичный отбор форматов | | Вирусность | просмотры относительно подписчиков | выход ролика за свою аудиторию | | Множитель | просмотры относительно обычного уровня автора | выброс на конкретном аккаунте | | ER | долю реакций среди просмотров | способность ролика вовлекать | | Просмотры | полученный охват | итоговый масштаб результата | В интерфейсе VM Score может называться **Vmax**. В документации это одна метрика. ## Вирусность Формула: ```text просмотры / подписчики × 100% ``` Значение 100% означает, что число просмотров равно числу подписчиков. Результат выше 100% показывает, что ролик вышел за размер своей аудитории. Метрика не доказывает, что все просмотры пришли от новых людей. ## Множитель Множитель сравнивает ролик со средними просмотрами аккаунта. Значение `1×` соответствует обычному уровню автора. Значение выше `1×` показывает отрыв от его нормы. На новом или небольшом аккаунте среднее может быть нестабильным. Не принимайте высокий множитель одного ролика за устойчивый паттерн без сравнения с другими публикациями. ## ER Отображаемая формула: ```text (лайки + комментарии + репосты + сохранения) / просмотры × 100% ``` ER помогает отличить охват от реакции. Сравнивайте ролики одной платформы, потому что доступность отдельных реакций зависит от источника данных. ## Как принять решение 1. Отберите ролики по VM Score. 2. Проверьте вирусность и множитель в контексте размера автора. 3. Сравните ER у роликов одного типа и платформы. 4. Откройте сильный и слабый ролик, затем сравните их хук и удержание. Цифры не объясняют причину результата. Для этого используйте [разбор контента](/docs/analytics/content) и данные удержания, если платформа их предоставляет. --- # Обновление аккаунтов routePath: /docs/analytics/refresh Раздел: Аналитика Описание: Настройте частоту, окно сбора и ручное обновление профилей. # Обновление аккаунтов На странице [Обновление](/analytics/refresh) вы управляете свежестью аналитики. Здесь задаются частота, окно сбора и ручной запуск для своих аккаунтов и конкурентов. Обновление статистики стоит 1 энергии за ролик в день, для Facebook применяется коэффициент ×2. Пример: 3 аккаунта с окном в 20 роликов при ежедневном сборе расходуют до 60 энергии в день. Итог всегда виден до подтверждения, подробнее в разделе [Энергия и лимиты](/docs/reference/energy). ## Прочитайте статус | Статус | Что делать | | ---------- | ------------------------------------------- | | Свежий | ничего, данные соответствуют расписанию | | Устарел | запустить обновление или проверить частоту | | На паузе | проверить подписку и возобновить расписание | | Ошибка | исправить профиль и запустить перепроверку | | Вручную | обновлять только по запросу | | Без данных | запустить первый сбор | Цветная метка в списке аккаунтов показывает ту же свежесть. Расшифровка цветов приведена в разделе [Подключение аккаунтов](/docs/settings/accounts). Таблица: статус, последнее обновление, период и настройка по строке. ## Запустите обновление - Для одного профиля откройте строку и выберите разовый запуск или расписание. - Для нескольких профилей отметьте строки и используйте массовое действие. - Кнопка обновления устаревших запускает сбор по профилям, которым он нужен. Система списывает энергию по фактически обработанным роликам. Ошибочный профиль обычный запуск пропускает. После смены ника или открытия приватного аккаунта используйте **«Перепроверить»**. ## Выберите окно Пресет автоматического обновления запускается ежедневно ночью, с 00:30 до 02:00, и собирает публикации с метриками за последние 7 дней. Короткое окно и частое расписание подходят активным аккаунтам. Режим с последними роликами полезен, когда важнее фиксированное число публикаций. Ручной режим сохраняет собранные данные и останавливает автоматические расходы. Для Instagram можно выбрать тип контента, если этот параметр доступен у выбранного профиля. Массовая настройка применяет одно расписание ко всем отмеченным строкам. Слишком узкий лимит роликов может пропустить часть публикаций в день массового постинга. Если интерфейс показывает пик, увеличьте лимит или выберите более частое расписание. Текущий баланс и управление оплатой находятся в [настройках тарифа](/settings/billing). --- # Уведомления routePath: /docs/analytics/notifications Раздел: Аналитика Описание: Настройте сигналы и сводки в Telegram и проверьте, почему они не приходят. # Уведомления Уведомления отправляют сигналы и сводки в Telegram. Настройка бесплатна и не расходует энергию. Всё настраивается в одном месте, в разделе [Настройки → Интеграции](/settings/notifications): сначала подключите Telegram, затем в блоке «Уведомления» создайте подписку. Продукт сам предложит первое уведомление, когда вы добавите свой аккаунт, конкурента или креатора. ## Создайте подписку Каждая строка связывает один тип уведомления с одним чатом. Один сигнал можно отправлять в несколько чатов, а один чат может получать разные типы. 1. Нажмите **«Добавить уведомление»**. 2. Выберите тип. 3. Выберите личный или групповой чат. 4. Настройте расписание и параметры типа. 5. Выполните тестовую отправку из меню строки. Расписание задаётся днями недели и временем в часовом поясе подписки. Изменения сохраняются сразу. Статус и время последней отправки помогают проверить, что подписка работает. ## Доступные сигналы | Тип | Что придёт | | ------------------------------ | --------------------------------------------------- | | Залетевшее видео | ролик резко набирает просмотры у вас или конкурента | | Видео пробило планку | ролик набрал заданные просмотры или репосты | | Сводка по моим аккаунтам | публикации и просмотры за период | | Рекап по конкурентам за неделю | просмотры за скользящие 7 дней и топ прироста | | Напоминания о съёмках | сценарии на сегодня и просроченные за 14 дней | | Автоматизация остановилась | слетел доступ или ответы воронки не уходят | | Дайджест по креаторам за день | кто сколько выложил вчера и кто недобрал норму | | Итоги недели по креаторам | видео и просмотры каждого креатора за неделю | Для «Залетевшего видео» вы выбираете охват и чувствительность. Для планки задаёте порог сами: пустое поле означает, что метрика не отслеживается. Проверка планки идёт каждые 15 минут, уведомление приходит один раз на видео, а поднятый порог взводит его заново. «Автоматизация остановилась» присылает одно сообщение на инцидент и одно о восстановлении. Креаторские типы доставляются только при доступе к разделу креаторов. Остальные работают с подключёнными своими аккаунтами и конкурентами. ## Если сообщение не пришло Проверьте: - бот всё ещё находится в выбранном чате; - у подписки включён статус; - расписание использует правильный часовой пояс; - в выбранном окне есть данные, которые проходят условие; - аккаунты обновлялись после создания подписки. «Залетевшее видео» и напоминания не отправляют сообщение, если событий нет: тишина в такой день не ошибка. Используйте предпросмотр и тест, чтобы отделить отсутствие события от ошибки доставки. Slack, Discord и Google Таблицы используются для экспорта отчётов. Уведомления сейчас доставляются через Telegram. --- # Воронки в Instagram routePath: /docs/automations/funnels Раздел: Автоматизации Описание: Настройте ответ на кодовое слово в Instagram и проверьте доставку и лиды. # Воронки в Instagram Воронка отвечает на комментарий или сообщение и отправляет материал в Директ. Она работает от имени подключённого профессионального Instagram-аккаунта. ## Подготовьте аккаунт Для автоматизации нужен отдельный вход в Instagram с разрешениями на комментарии и сообщения. Подключения для публичной аналитики недостаточно. Если Meta отозвала доступ, в разделе [Аккаунты автоматизаций](/automations/accounts) появится требование переподключить профиль. Доступность воронок и число активных аккаунтов зависят от тарифа. Сами срабатывания не расходуют энергию. ## Создайте правило Откройте [Воронки](/automations/rules) и нажмите **«Создать воронку»**. Можно начать с шаблона или пустой формы. ### Выберите точку входа Укажите аккаунт, кодовые слова и события. Воронка может реагировать на комментарии, ответы на сторис или сообщения в Директ. ### Настройте путь Решите, отправлять материал сразу или после нажатия кнопки. Проверка подписки доступна в пути с кнопкой. ### Напишите финальное сообщение Добавьте текст и при необходимости кнопку со ссылкой. Предпросмотр справа показывает путь человека до сохранения. ### Проверьте публичный ответ Если нужен ответ под комментарием, добавьте несколько естественных вариантов. Он сообщает, что материал уже отправлен в Директ. Короткое кодовое слово может совпадать с обычными комментариями. Выбирайте фразу, которую человек пишет намеренно. Viralmaxing не разрешает конфликтующие слова у правил одного аккаунта. ## Проверьте запуск Воронка начинает работать после сохранения. Оставьте тестовый комментарий с другого аккаунта и проверьте четыре точки: 1. правило зарегистрировало событие; 2. сообщение пришло в Директ; 3. публичный ответ появился, если он включён; 4. человек появился в [Лидах](/automations/leads). [Обзор](/automations/results) показывает срабатывания, слова и публикации. В [Лидах](/automations/leads) находится история конкретного человека и ручной ответ. Meta ограничивает ручной ответ временным окном после сообщения человека. Если карточка показывает «Окно закрыто», первым написать уже нельзя. ## Если воронка молчит Проверьте статус правила, выбранный аккаунт, права Meta, кодовое слово и включённые типы событий. Для группы «Все аккаунты» учтите, что новые подключения тоже попадают под активное правило и занимают лимит тарифа. Простую воронку можно создать через [ассистента](/assistant). Перед подтверждением он показывает текст, слово и ссылку. Сложные шаги добавьте в редакторе правила. --- # Поиск идей routePath: /docs/research/idea-search Раздел: Поиск идей Описание: Найдите ролики по слову, описанию или аккаунту конкурента и заберите их в План. # Поиск идей Один поиск собирает ролики и авторов по вашей теме. Запуск стоит 30 энергии. Найденные ролики можно сохранить бесплатно или превратить в сценарии. ## Запустите поиск ### Выберите режим Используйте «Слово или хэштег» для точной фразы и «Описание идеи» для смыслового запроса. Ролики уже отслеживаемых аккаунтов собраны на вкладке «Конкуренты». ### Сформулируйте задачу Укажите тему, аудиторию или формат. Например: `короткие видео для психолога о тревожности без лица`. ### Проверьте стоимость Кнопка **«Найти»** показывает цену. Если энергии не хватает, Viralmaxing остановит запуск до списания. Переключатель режимов, поле запроса и цена запуска. Вкладка «Конкуренты» работает только с добавленными аккаунтами. Если список пуст, сначала откройте [Аккаунты → Конкуренты](/analytics/accounts?scope=competitor). ## Отберите кандидатов Выдача открывается в виде сетки или таблицы. Начните с трёх показателей: | Метрика | На какой вопрос отвечает | | ---------- | ----------------------------------------------------- | | VM Score | каков вирусный потенциал ролика по шкале от 0 до 100 | | Вирусность | насколько просмотры превышают размер аудитории автора | | ER | какую долю просмотров превратили в реакции | По умолчанию выдача отсортирована по просмотрам. Переключите сортировку на вирусность, если ищете формат, который сработал у небольшого аккаунта без большой базы подписчиков. Табличный вид выдачи: вирусность, ER и просмотры по каждому ролику. Предупреждение о низком покрытии или уверенности означает, что данных для запроса мало. Добавьте ещё одно точное направление или расширьте формулировку. ## Расширьте удачную сессию Не запускайте новый поиск, пока текущая сессия отвечает на задачу. Кнопки догрузки добавляют ролики в тот же результат. Каждая догрузка является новым поиском и стоит 30 энергии. Сохранённые сессии находятся на главной странице поиска. Их можно переименовать и добавить в избранное. Повтор неудавшегося поиска создаёт новую платную сессию. Статусы, избранное и названия сохранённых сессий. ## Сохраните или адаптируйте ролик - Закладка добавляет ролик в [подборку](/docs/research/collections) бесплатно. - **«Адаптировать»** создаёт сценарий в [Плане](/docs/scenarios/plan) за 1 энергии. - Открытие карточки показывает метрики и доступную расшифровку. Новый разбор стоит 10 энергии. Карточка ролика: метрики и кнопка «Адаптировать». Снятие отслеживания с автора может удалить его ролики из аналитики. Перед подтверждением проверьте, что вы меняете аккаунт, а не закладку одного ролика. --- # Подборки routePath: /docs/research/collections Раздел: Подборки Описание: Сохраняйте ролики в подборки, разбирайте их вместе и выгружайте для команды. # Подборки Подборка хранит ролики по одной теме, клиенту или формату. Сохранение уже найденного ролика бесплатно. Импорт новой ссылки стоит 1 энергии за ролик. ## Создайте подборку 1. Откройте [Подборки](/explore/collections) и нажмите **«Создать подборку»**. 2. Дайте ей название, которое объясняет критерий отбора. Например, «Хуки для запуска». 3. В поиске идей или аналитике нажмите закладку на карточке ролика. Один ролик может находиться в нескольких подборках. Удаление из одной не меняет остальные. ## Добавьте ролики по ссылке Кнопка добавления в шапке принимает ссылки на TikTok, Instagram и YouTube. Вставляйте по одной ссылке на строку. Viralmaxing показывает распознанные и ошибочные ссылки до запуска. Плата списывается только за ролик, которого ещё нет в базе. После отправки импорт продолжается в фоне, поэтому метрики могут появиться не сразу. Итоговый отчёт показывает принятые ссылки и причины ошибок. ## Сравните подборку Используйте таблицу, когда нужно сопоставить VM Score, вирусность, ER и просмотры. Сетка лучше подходит для быстрого просмотра обложек и форматов. Фильтры работают только внутри текущей подборки. Они не запускают новый поиск и не расходуют энергию. Настроенный набор колонок сохраняется и используется при экспорте. ## Передайте результат Выгрузите текущую таблицу в CSV или Excel. Экспорт бесплатен. Если команда работает внутри Viralmaxing, отправьте ссылку на подборку и заранее договоритесь о критерии отбора. Удаление подборки необратимо, но не удаляет сами ролики из Viralmaxing. Они останутся в других подборках и разделах, где были сохранены. Когда выбор сделан, создайте сценарии через [План](/docs/scenarios/plan). --- # План и сценарии routePath: /docs/scenarios/plan Раздел: Сценарии Описание: Ведите сценарии на доске, в списке или календаре и сохраняйте версии текста. # План и сценарии [План](/plan) хранит сценарии, статусы и даты публикаций. Один набор данных можно смотреть как канбан, список или календарь. ## Создайте сценарий Кнопка **«+»** предлагает пустой сценарий или создание из ссылки. Сценарий также появляется после действия **«Адаптировать»** в поиске идей и аналитике. Создание стоит 1 энергии. Привязанный ролик сохраняет рядом обложку, метрики и доступную расшифровку. ## Подготовьте текст ### Выберите отправную точку Начните с пустого текста, обсуждения с AI или расшифровки привязанного ролика. Новая расшифровка стоит 10 энергии. ### Исправляйте фрагменты Выделите хук, абзац или призыв и отправьте конкретную задачу. Без выделения ассистент работает со всем сценарием. ### Проверьте разницу AI показывает добавленные и удалённые части. Нажмите **«Применить»** только после чтения предложения. ### Сохраните изменения Ручные правки не сохраняются автоматически. Индикатор «Изменено» означает, что AI пока видит последнюю сохранённую версию. AI-переписывание стоит 3 энергии. Точечная правка фрагмента стоит 1 энергии. Ручной набор и сохранение бесплатны. ## Восстановите версию Сохранённые изменения образуют версии. Выберите старую версию, сравните её с текущей и нажмите **«Восстановить»**. Восстановление создаёт новую версию и не стирает историю. Архивирование переносит сценарий в отменённые и допускает возврат. Удаление необратимо. ## Организуйте работу - Канбан показывает этапы и позволяет менять статус перетаскиванием. - Список удобен для линейного просмотра и мобильного экрана. - Календарь показывает запланированные даты публикаций. Доска: колонки-статусы, карточки с датами и исходными роликами. В [настройках Плана](/settings/plan) можно управлять статусами, дорожками и тегами. Дорожки подходят для каналов, клиентов или серий. Категория статуса помогает системе понимать этап, а название можно адаптировать под процесс команды. Экспорт сохраняет текущие фильтры и видимые поля. Готовый текст также можно скопировать без таймкодов или скачать в `.txt`. Если исходный ролик удалён на платформе, сценарий и сохранённый текст остаются доступными. Повторная расшифровка и загрузка медиа могут завершиться ошибкой. --- # AI-ассистент routePath: /docs/assistant/overview Раздел: AI-ассистент Описание: Работайте с аккаунтами, роликами и сценариями через чат в текущем пространстве. # AI-ассистент Ассистент отвечает по данным текущего пространства. Он может разобрать ролик, найти идеи и подготовить сценарий. Действия, которые меняют данные или расходуют энергию, требуют вашего подтверждения. ## Что ассистент умеет | Умеет | Не умеет | | ------------------------------------------------------------ | -------------------------------------------- | | искать идеи и разбирать ролики по вашим данным | публиковать и планировать посты в соцсетях | | создавать и править сценарии в Плане | менять тариф и управлять оплатой | | сравнивать ваши аккаунты и конкурентов за период | добавлять участников и менять роли | | создавать [простую воронку](/docs/automations/funnels) | отвечать по данным другого пространства | Тот же набор возможностей доступен внешним AI-агентам через [MCP и API](/developers): Claude или другой ассистент подключается к тем же данным с теми же подтверждениями. ## Дайте нужный контекст Откройте [AI-ассистент](/assistant) и сформулируйте результат. Например: `сравни мои лучшие ролики за месяц и предложи три темы для следующей недели`. К сообщению можно прикрепить аккаунт, ролик или поддерживаемый файл. Ссылку на видео можно вставить прямо в текст. AI-профиль в [настройках](/settings/ai) добавляет нишу, аудиторию и постоянные требования к стилю. Если подключённых данных нет, ассистент не сможет сравнить ваши результаты. Сначала добавьте профиль в [Аккаунтах](/analytics/accounts?scope=own). ## Выполните задачу - Для разбора прикрепите ролик и спросите, что сработало в хуке, структуре и реакции аудитории. - Для поиска назовите тему и платформу. Поиск идей стоит 30 энергии. - Для сценария опишите формат или приложите ролик. Создание сценария стоит 1 энергии. Большой результат открывается в отдельной панели. Оттуда его можно обсудить в чате, скопировать или продолжить в Плане. ## Подтвердите изменения Когда ассистент предлагает создать или изменить объект, появляется панель действий. **«Выполнить»** применяет предложение, **«Уточнить»** отправляет правку, **«Отменить»** закрывает действие. Текстовое сообщение «да» не заменяет кнопку подтверждения. Это защищает от случайного изменения данных и незаметного списания энергии. Проверяйте выбранное пространство перед выполнением действия. Ассистент использует его аккаунты, сценарии и баланс. ## Работайте с историей Чаты сохраняются автоматически. Их можно закрепить, переименовать, архивировать, экспортировать или удалить. Архивирование обратимо. Удаление восстановить нельзя. Начинайте новый чат при смене темы. Так контекст старой задачи не будет влиять на ответ. Практические шаблоны запросов собраны в разделе [Как писать запросы](/docs/assistant/effective-prompts). --- # Как писать запросы ассистенту routePath: /docs/assistant/effective-prompts Раздел: AI-ассистент Описание: Формулируйте результат, формат и ограничения, чтобы получать полезный ответ с первой попытки. # Как писать запросы ассистенту Хороший запрос называет результат, исходные данные и ограничения. Ассистент уже знает инструменты Viralmaxing, поэтому длинная ролевая инструкция ему не нужна. ## Шаблон запроса Соберите фразу из четырёх частей: 1. **Действие.** Что нужно сделать: найти, сравнить, разобрать или написать. 2. **Источник.** Какие аккаунты, ролики или период использовать. 3. **Формат.** Сценарий, таблица, список хуков или план публикаций. 4. **Ограничение.** Платформа, длительность, аудитория или число вариантов. ## Готовые формулировки под реальные задачи Скопируйте и подставьте свою тему. Рядом указано, что запрос стоит: чтение уже собранных данных бесплатно, создание нового расходует [энергию](/docs/reference/energy), и ассистент показывает цену до запуска. **Разбор своих результатов, бесплатно:** > Сравни мои ролики за последние 30 дней с предыдущими 30. Назови три вывода и один эксперимент на следующий период. Выводы покажи списком со ссылками на ролики. **Идеи с адаптацией, поиск 30 энергии плюс 1 энергии за сценарий:** > Найди десять роликов про уход за кожей в Instagram Reels, выбери три самых повторяемых формата и адаптируй каждый в сценарий до 30 секунд для косметолога. **Разбор чужого ролика, 10 энергии:** > Разбери этот ролик: что держит внимание в хуке и структуре, что из этого повторить в моей нише. Ссылка в сообщении. **Правка сценария, 1 энергии за фрагмент:** Откройте сценарий в [Плане](/plan), выделите фрагмент и напишите задачу: > Сократи хук до восьми слов и замени вопрос на утверждение. ## Давайте задачу целиком Если итог требует разбора и создания, объедините их в одном запросе. Это помогает ассистенту сохранить критерий отбора. Вместо двух сообщений «разбери ролики» и «теперь напиши сценарии» используйте: > Разбери десять лучших роликов конкурента за месяц, назови общие паттерны и напиши три сценария по самому устойчивому паттерну. ## Исправляйте конкретно После первого ответа назовите, что меняете. Например: - `сократи сценарий до 20 секунд`; - `замени вопрос в хуке на утверждение`; - `оставь структуру, но убери профессиональный жаргон`; - `покажи выводы таблицей и добавь ссылки на ролики`. Постоянные требования к голосу и стоп-словам лучше записать в [AI-профиле](/settings/ai). В чате оставляйте требования к текущей задаче. ## Используйте улучшение промпта Кнопка **«Улучшить промпт»** переписывает черновик до отправки. Проверьте предложенный вариант и выберите **«Оставить»** или **«Вернуть»**. Ничего не отправляется автоматически. ## Избегайте двух ошибок - Общий запрос вроде `помоги с контентом` не задаёт проверяемый результат. - Длинная роль вроде `действуй как эксперт с десятью годами опыта` занимает место, но не уточняет задачу. При смене темы начните новый чат. Если нужен полный рабочий маршрут, откройте [гайд от идеи до сценария](/docs/guides/getting-started). --- # Команда и пространства routePath: /docs/collaboration/team Раздел: Команда и пространства Описание: Разделите данные по пространствам и выдайте участникам подходящие роли. # Команда и пространства Пространство определяет, какие данные видит участник. Роль определяет, что он может с ними делать. Настраивайте оба параметра отдельно. ## Разделите клиентов Создайте пространство в [Настройках](/settings/workspaces), затем переключитесь в него и добавьте аккаунты клиента. Новое пространство пустое. Существующие данные остаются в прежнем контексте. Активное пространство используется в аналитике, Плане, ассистенте, а также в [MCP и API](/developers). Проверяйте его перед платной операцией или массовым изменением. Архивирование скрывает пространство и позволяет восстановить его. Удаление необратимо и требует точного подтверждения имени. Переключение, архивирование или удаление активного пространства перезагружает страницу. Сохраните сценарий и завершите текущий ответ ассистента заранее. ## Пригласите участника 1. Откройте [Команду](/settings/team) и нажмите **«Пригласить»**. 2. Укажите email. 3. Выберите роль. 4. Дайте доступ ко всем или только к выбранным пространствам. 5. Отправьте приглашение. Приглашение нужно принять под тем же email. Число участников ограничено тарифом. Ожидающие и истёкшие приглашения занимают место в лимите, пока вы их не удалите. ## Выберите роль | Роль | Может делать | | ------------- | ---------------------------------------------- | | Наблюдатель | смотреть аналитику, План и сценарии | | Редактор | создавать контент и запускать рабочие операции | | Администратор | управлять командой, пространствами и оплатой | Администратор получает права аккаунта, даже если видит только одно пространство. Для клиента обычно подходит Наблюдатель, для внешнего автора Редактор, для совладельца Администратор. Удаление участника отзывает доступ сразу, но не удаляет созданные им сценарии. Снижение роли также сохраняет историю работы. ## Следите за расходом Команда использует общий баланс владельца. Редактор может запускать поиск, разбор и AI-правки, но не управляет оплатой. Планируйте лимит с учётом числа активных участников и проверяйте остаток в [настройках тарифа](/settings/billing). Что расходует энергию и что бесплатно, описано в разделе [Энергия и лимиты](/docs/reference/energy). Для агентского маршрута от создания клиента до проверки доступа откройте гайд [«Я веду клиентов»](/docs/guides/agency). --- # Подключение аккаунтов routePath: /docs/settings/accounts Раздел: Настройки Описание: Подключите свои профили и конкурентов и настройте сбор статистики. # Подключение аккаунтов Добавьте свои профили для анализа результатов и конкурентов для наблюдения за нишей. Экран [Аккаунты](/analytics/accounts?scope=own) управляет списком. Частота сбора настраивается отдельно в разделе [Обновление](/docs/analytics/refresh). ## Добавьте профиль 1. Выберите вкладку «Свои» или «Конкуренты». 2. Вставьте ссылку или ник, по одному профилю на строку. 3. Проверьте определённую платформу. 4. Выберите объём загружаемых роликов. 5. Проверьте итоговую стоимость и запустите сбор. Импорт стоит 1 энергии за новый ролик, для Facebook действует коэффициент ×2. Viralmaxing показывает сумму до подтверждения. Публичные аккаунты Instagram, TikTok, YouTube и Facebook можно добавить без передачи пароля от соцсети. Отдельный вход владельца нужен для данных, которые платформа не отдаёт публично, например для части YouTube-удержания. ## Разделяйте свои и чужие аккаунты Свои профили попадают в общую аналитику результатов. Конкуренты используются в сравнении и ленте чужих роликов. Перемещение между вкладками меняет роль профиля, но сохраняет уже собранную статистику. Если вы не знаете конкретных конкурентов, [поиск похожих аккаунтов](/explore/discover) работает по выбранным источникам и стоит 200 энергии за каждый источник. ## Проверьте свежесть Цветная метка показывает дату последнего обновления: - зелёная, менее трёх дней; - жёлтая, от трёх до семи дней; - красная, более семи дней или ошибка; - серая, данных ещё нет. Аккаунты, свежесть данных и основные показатели. Клик по метке ведёт к расписанию. Там можно выполнить разовый сбор, выбрать пресет или включить ручной режим. Разовый запуск, частота и окно сбора профиля. ## Исправьте ошибку профиля | Состояние | Следующий шаг | | ------------------ | --------------------------------- | | Не найден | исправить ник или удалить профиль | | Приватный | открыть профиль и перепроверить | | Нет видео | расширить окно сбора | | Ограничен | повторить позже | | Нужна перепривязка | пройти подключение заново | После исправления используйте **«Перепроверить»**. Массовое обновление может пропускать профили с ошибкой. Снятие отслеживания убирает аккаунт и его ролики из вашей рабочей аналитики. Если нужно только остановить расходы, сначала переведите расписание в ручной режим. --- # Энергия и лимиты routePath: /docs/reference/energy Раздел: Справочник Описание: Разберитесь, какие действия расходуют энергию, что бесплатно и где проверить баланс. # Энергия и лимиты Энергия оплачивает создание нового: поиск, импорт данных, расшифровку и генерацию. Чтение уже собранного бесплатно. Это позволяет открывать аналитику, План и историю чатов сколько угодно раз без расхода. Перед каждым платным действием Viralmaxing показывает итоговую стоимость. Списание происходит только после вашего подтверждения. То же правило действует для ассистента и для [MCP и API](/developers): агент обязан назвать цену до запуска операции. ## Что расходует энергию - Поиск идей по слову, описанию или аккаунту стоит 30 энергии. - Поиск похожих аккаунтов стоит 200 энергии за каждый выбранный источник. - Разбор ролика или его расшифровка стоит 10 энергии. - Полное AI-переписывание сценария стоит 3 энергии. - Создание сценария из ролика и точечная AI-правка фрагмента стоят 1 энергии. - Импорт и обновление статистики стоят 1 энергии за ролик. Для Facebook действует коэффициент ×2. - Голосовой ввод стоит 1 энергии за сообщение. ## Что бесплатно - Просмотр аналитики, фильтры, сравнение периодов и экспорт. - Сохранение ролика в подборку. - Ручной набор и правка текста сценария, сохранение версий. - Анализ профиля аккаунта: темы, стили и сводка появляются без списания. - Уведомления в Telegram и их настройка. ## Где смотреть баланс Остаток, тариф и пополнение находятся в [настройках тарифа](/settings/billing). Актуальные условия и объём энергии по тарифам опубликованы на странице [Тарифы](/pricing). Документация не дублирует цены тарифов: источник правды продукт. Если энергии не хватает, платное действие не запускается, а продукт предлагает изменить тариф или пополнить баланс. Уже собранные данные при этом остаются доступными. ## Общий баланс команды Все участники пространства тратят энергию из баланса владельца аккаунта. Редактор может запускать поиск, разбор и AI-правки, поэтому планируйте лимит с учётом числа активных участников. Роли и модель доступа описаны в разделе [Команда и пространства](/docs/collaboration/team). Регулярный автоматический расход почти всегда создаёт [обновление аккаунтов](/docs/analytics/refresh). Если нужно остановить фоновые списания, переведите расписание профилей в ручной режим: данные сохранятся, а сбор прекратится. --- # Developer documentation locale: en routePath: /developers Описание: Connect Viralmaxing to AI agents through MCP or to applications through the REST API. # Developer documentation Connect Viralmaxing to an AI agent through MCP or call the REST API from your application. Both interfaces work with data in the selected workspace. ## Choose an interface ### MCP for an AI agent Claude, Cursor, and Codex receive Viralmaxing tools after browser sign-in. There is no API key to copy. ### REST API for an application Create a key and access data over HTTP. API Reference contains the current methods and response schemas. ## How access works Each connection is scoped to one workspace. Accounts, videos, scenarios, and automations in other workspaces remain unavailable until the agent switches explicitly. Reading existing data is free. Operations that create a new result spend energy. An MCP tool returns the exact price and requires `confirm_cost`, so the agent must get your approval before calling it. ## Machine-readable documents | File | Purpose | | ------------------------------------------------------------------------ | ------------------------------------------- | | [`/developers/llms.txt`](/developers/llms.txt) | Map of developer documents | | [`/agents.md`](/agents.md) | When to use Viralmaxing and how to connect | | [`/llms-full.txt`](/llms-full.txt) | Full product documentation corpus | | [`/.well-known/mcp/server-card.json`](/.well-known/mcp/server-card.json) | MCP endpoint, authentication, and tool list | REST methods, parameters, and response schemas are published in [API Reference](https://docs.viralmaxing.com). --- # MCP quick start locale: en routePath: /developers/mcp/quick-start Описание: Add the Viralmaxing MCP server, sign in through the browser, and give the agent its first safe request. # MCP quick start MCP gives an AI agent tools for reading analytics, researching videos, and working with scenarios. The connection uses OAuth, so its configuration needs no secrets. ## Server address ```text https://api.viralmaxing.com/api/mcp ``` The server uses Streamable HTTP. ## Claude Code Run this command in the project directory: ```bash claude mcp add --transport http --scope project viralmaxing https://api.viralmaxing.com/api/mcp ``` Open `/mcp` in the session and start sign-in for `viralmaxing`. Choose a workspace in the browser and approve access. ## Claude, Cursor, and other clients If the client accepts JSON configuration, add the server without custom headers or keys: ```json { "mcpServers": { "viralmaxing": { "type": "http", "url": "https://api.viralmaxing.com/api/mcp" } } } ``` In Claude, open connector settings and add a custom connector at the same address. In Cursor, use MCP settings. The client opens Viralmaxing sign-in after saving the server. [Settings → API keys](/settings/api) contains a ready-to-use agent prompt. It asks the agent to add the server, complete OAuth, and check the tool list. ## First request Ask the agent to call `list_workspaces`, then `list_my_accounts`. Both calls only read data and spend no energy. Continue with [connection verification](/developers/mcp/verification) to confirm that the agent is using the intended workspace. --- # Verify the connection locale: en routePath: /developers/mcp/verification Описание: Check the tool list, current workspace, and data access without running a paid operation. # Verify the connection Verify a connection with read operations. This separates access problems from paid work and leaves workspace data unchanged. ## 1. Get the tool list Ask the client to call `tools/list`. The result should contain Viralmaxing tools such as `list_workspaces`, `list_my_accounts`, and `list_posts`. An empty list usually means that sign-in is incomplete or the client configured the server as `stdio` instead of HTTP. ## 2. Check the workspace Call `list_workspaces`. The result lists available workspaces and marks the current one. When the user names a client or brand, select its workspace through `switch_workspace` before reading data. An unexpectedly empty account list often means that the agent is in the wrong workspace. ## 3. Read data Call one safe tool: - `list_my_accounts` for the user's own profiles; - `list_competitors` for tracked competitors; - `get_energy_balance` for the plan and remaining balance. A successful result confirms the transport, authentication, and data scope. ## Before a paid call Research, transcription, and import tools return a price. State it to the user, wait for explicit approval, then call the tool again with the exact `confirm_cost`. Never loop a paid tool. --- # MCP troubleshooting locale: en routePath: /developers/mcp/troubleshooting Описание: Checks for missing tools, repeated sign-in, incorrect workspace data, and authorization errors. # MCP troubleshooting ### The client cannot see tools Check the address `https://api.viralmaxing.com/api/mcp` and use HTTP transport. Remove a trailing slash, custom headers, and API keys from the OAuth configuration. Reconnect the server and call `tools/list` again. ### Sign-in keeps opening The token may have expired or the connection may have been revoked. Open [Settings → API keys](/settings/api), check connected agents, and start sign-in again. If the client retains the old session, remove the server from the client and add it again. ### The agent sees the wrong data Call `list_workspaces` and check the current workspace. Switching through MCP changes context only for that connection. It does not change the workspace open in the user's app. ### A paid tool returns an error Read the quoted price first. Get the user's approval and pass the exact value as `confirm_cost`. A different amount is rejected. Retrying cannot fix an inactive plan or insufficient energy. ### The server returns 401 The client did not send a valid token. Refresh the OAuth session or sign in again. For unattended server automation, use an [API key](/developers/rest/authentication). ### The server returns 403 The connection is valid, but the workspace role does not allow this operation. Ask the workspace owner to perform the action or provide suitable access. If these checks do not resolve the problem, open support from the documentation header. Include the client name, error text, and request time. Do not send tokens or keys. --- # Viralmaxing skills for agents locale: en routePath: /developers/mcp/skills Описание: Five ready-made skills and the connector in one command: npx skills add Viralmaxing/skill. # Viralmaxing skills for agents The connector gives an agent tools. The skills explain **how to use them**: where to start when breaking down an account, how research differs from reading the plan, which calls cost energy, and when to ask before spending it. The repository is public and generated from the product's own source, so it cannot drift from it: [Viralmaxing/skill](https://github.com/Viralmaxing/skill). ## Install ```bash npx skills add Viralmaxing/skill ``` One command installs both the skills and the MCP server: the repository follows the Agent Plugins spec: `skills/` for the skills, `mcp.json` for the connector. You do not need to add the server separately afterwards. If you only want the connector, without the skills: ```bash claude mcp add --transport http --scope project viralmaxing https://api.viralmaxing.com/api/mcp ``` ## What is inside | Skill | What it covers | | --- | --- | | `viralmaxing-analytics` | Metrics for tracked accounts: views, engagement, movement over time | | `viralmaxing-research` | Comparison against competitors, discovery of new accounts and ideas | | `viralmaxing-video` | Transcript and metric detail for one video | | `viralmaxing-plan` | The content plan: take a video into work, write and move a scenario | | `viralmaxing-automations` | Instagram comment-to-Direct funnels | The split is deliberate: an agent loads only the skill a request needs instead of spending context on the rest. ## Sign-in and money The skills carry no secrets. Authorization goes through OAuth in the browser, same as the connector itself. See [MCP quick start](/developers/mcp/quick-start). Paid actions never run silently: the tool quotes its price and waits for confirmation. What costs what is in the [energy reference](/docs/reference/energy). --- # REST API quick start locale: en routePath: /developers/rest/quick-start Описание: Create an API key, store it in an environment variable, and make the first request. # REST API quick start The REST API suits server integrations, reports, and internal tools. For an AI client with a person present, [MCP](/developers/mcp/quick-start) is usually simpler. ## 1. Create a key Open [Settings → API keys](/settings/api), select Create, and give the key a recognizable name. Copy the full key immediately. It is not shown again after you close the dialog. ## 2. Store the secret Keep the key in an environment variable instead of source code: ```bash export VIRALMAXING_API_KEY='vmx_...' ``` Do not commit `.env` or put the key in a URL. ## 3. Make a request ```bash curl --request GET \ --url https://api.viralmaxing.com/api/users/api-keys/ \ --header "X-API-Key: $VIRALMAXING_API_KEY" ``` The request returns the key list without secret values. A `200` response confirms that the key was accepted. API base URL: ```text https://api.viralmaxing.com/api ``` Open [API Reference](https://docs.viralmaxing.com) to choose a method and inspect its parameters. --- # REST API authentication locale: en routePath: /developers/rest/authentication Описание: How to send, store, rotate, and revoke an API key without exposing it. # REST API authentication An API key starts with `vmx_` and grants access to one workspace. Send it with every request in one of two ways. ## X-API-Key header ```http X-API-Key: vmx_... ``` This is the primary and most explicit option. ## Bearer token ```http Authorization: Bearer vmx_... ``` Both headers are accepted equally. Do not send them together. ## Storage and rotation - keep the key in a secret manager or environment variable; - create a separate key for each integration; - review its last-used date in settings; - delete it after a leak, ownership change, or integration shutdown. Deletion revokes access immediately. A lost key cannot be recovered. Create a replacement and delete the old key. Do not embed a key in browser JavaScript, a mobile application, or a public repository. Requests carrying the secret must originate from your server. ## Access errors `401` means that the key is missing, invalid, expired, or revoked. `403` means the key is valid, but the user's workspace role does not allow the operation. --- # Your first REST request locale: en routePath: /developers/rest/first-request Описание: Verify a key with cURL or server-side JavaScript and handle common API responses. # Your first REST request Start with a read. It verifies authentication without changing workspace data. ## cURL ```bash curl --request GET \ --url https://api.viralmaxing.com/api/analytics/accounts/ \ --header "X-API-Key: $VIRALMAXING_API_KEY" \ --header "Accept: application/json" ``` ## Server-side JavaScript ```js const response = await fetch('https://api.viralmaxing.com/api/analytics/accounts/', { headers: { Accept: 'application/json', 'X-API-Key': process.env.VIRALMAXING_API_KEY, }, }); if (!response.ok) { throw new Error(`Viralmaxing API returned ${response.status}`); } const accounts = await response.json(); ``` ## Interpret the response - `200` means the request succeeded; - `400` points to invalid parameters or a business constraint; - `401` requires a valid key; - `403` points to an insufficient workspace role; - `429` requires a delay before retrying. Do not retry an unchanged request after `400`. Read the error body and correct the parameters. Use increasing backoff for `429`. All available paths and response schemas are in [API Reference](https://docs.viralmaxing.com). --- # Документация для разработчиков locale: ru routePath: /ru/developers Описание: Подключение Viralmaxing к AI-агентам через MCP и к приложениям через REST API. # Документация для разработчиков Подключите Viralmaxing к AI-агенту через MCP или вызывайте REST API из своего приложения. Оба интерфейса работают с данными выбранного пространства. ## Выберите интерфейс ### MCP для AI-агента Claude, Cursor и Codex получают инструменты Viralmaxing после входа через браузер. API-ключ копировать не нужно. ### REST API для приложения Создайте ключ и обращайтесь к данным по HTTP. Схемы методов и ответов находятся в API Reference. ## Как устроен доступ Каждое подключение привязано к одному пространству. Аккаунты, ролики, сценарии и автоматизации из других пространств не видны, пока агент не переключится в них явно. Чтение уже собранных данных бесплатно. Операции, которые создают новый результат, расходуют энергию. MCP-инструмент сообщает точную цену и требует `confirm_cost`, поэтому агент должен получить ваше согласие до вызова. ## Что читать агенту | Файл | Для чего нужен | | ------------------------------------------------------------------------ | ------------------------------------------------- | | [`/developers/llms.txt`](/developers/llms.txt) | Карта документов для разработчиков | | [`/agents.md`](/agents.md) | Когда использовать Viralmaxing и как подключиться | | [`/llms-full.txt`](/llms-full.txt) | Полный корпус документации продукта | | [`/.well-known/mcp/server-card.json`](/.well-known/mcp/server-card.json) | Адрес MCP, способ входа и список инструментов | Список методов REST, параметры и схемы ответов публикуются в [API Reference](https://docs.viralmaxing.com). --- # Быстрый старт с MCP locale: ru routePath: /ru/developers/mcp/quick-start Описание: Добавьте MCP-сервер Viralmaxing, войдите через браузер и дайте агенту первый безопасный запрос. # Быстрый старт с MCP MCP даёт AI-агенту инструменты для чтения аналитики, исследования роликов и работы со сценариями. Подключение использует OAuth, поэтому секреты в конфигурации не нужны. ## Адрес сервера ```text https://api.viralmaxing.com/api/mcp ``` Транспорт сервера: Streamable HTTP. ## Claude Code Выполните команду в каталоге проекта: ```bash claude mcp add --transport http --scope project viralmaxing https://api.viralmaxing.com/api/mcp ``` Откройте `/mcp` в сессии и запустите вход для `viralmaxing`. В браузере выберите пространство и подтвердите доступ. ## Claude, Cursor и другие клиенты Если клиент принимает JSON-конфигурацию, добавьте сервер без заголовков и ключей: ```json { "mcpServers": { "viralmaxing": { "type": "http", "url": "https://api.viralmaxing.com/api/mcp" } } } ``` В Claude откройте настройки коннекторов и добавьте свой коннектор по тому же адресу. В Cursor используйте настройки MCP. После сохранения клиент откроет страницу входа Viralmaxing. В [Настройки → API-ключи](/settings/api) есть готовый промпт для агента. Он просит добавить сервер, пройти OAuth и проверить список инструментов. ## Первый запрос Попросите агента выполнить `list_workspaces`, затем `list_my_accounts`. Оба вызова только читают данные и не расходуют энергию. Перейдите к [проверке подключения](/ru/developers/mcp/verification), чтобы убедиться, что агент находится в нужном пространстве. --- # Проверка подключения locale: ru routePath: /ru/developers/mcp/verification Описание: Проверьте список инструментов, текущее пространство и доступ к данным без платных операций. # Проверка подключения Проверяйте соединение чтением. Так вы отделите проблему доступа от платной операции и не измените данные пространства. ## 1. Получите список инструментов Попросите клиента вызвать `tools/list`. В ответе должны быть инструменты Viralmaxing, в том числе `list_workspaces`, `list_my_accounts` и `list_posts`. Если список пуст, клиент ещё не завершил вход или подключил сервер как `stdio` вместо HTTP. ## 2. Проверьте пространство Вызовите `list_workspaces`. Ответ показывает доступные пространства и отмечает текущее. Если пользователь назвал клиента или бренд, сначала выберите соответствующее пространство через `switch_workspace`. Пустой список аккаунтов часто означает, что агент смотрит не в то пространство. ## 3. Прочитайте данные Вызовите один из безопасных инструментов: - `list_my_accounts` для собственных профилей; - `list_competitors` для отслеживаемых конкурентов; - `get_energy_balance` для тарифа и доступного остатка. Успешный ответ подтверждает транспорт, авторизацию и область данных. ## Перед платным вызовом Инструменты исследования, расшифровки и импорта сообщают стоимость. Назовите её пользователю, дождитесь явного согласия и только после этого повторите вызов с точным `confirm_cost`. Не запускайте платный инструмент циклом. --- # Проблемы с MCP locale: ru routePath: /ru/developers/mcp/troubleshooting Описание: Что проверить, если клиент не видит инструменты, вход зациклился или данные пространства не совпадают. # Проблемы с MCP ### Клиент не видит инструменты Проверьте адрес `https://api.viralmaxing.com/api/mcp` и тип транспорта HTTP. Уберите слеш в конце, пользовательские заголовки и API-ключ из OAuth-конфигурации. Затем переподключите сервер и снова вызовите `tools/list`. ### Вход открывается повторно Токен мог истечь или подключение было отозвано. Откройте [Настройки → API-ключи](/settings/api), проверьте список подключённых агентов и запустите вход заново. Если клиент хранит старую сессию, удалите сервер из него и добавьте снова. ### Агент видит не те данные Вызовите `list_workspaces` и проверьте текущее пространство. Переключение внутри MCP меняет контекст только для этого подключения. Оно не меняет пространство, открытое у пользователя в приложении. ### Платный инструмент возвращает ошибку Сначала прочитайте цену из ответа. Затем получите согласие пользователя и передайте точное значение в `confirm_cost`. Другая сумма будет отклонена. Ошибка о тарифе или недостатке энергии не исправляется повторным вызовом. ### Сервер возвращает 401 Клиент не передал действующий токен. Обновите OAuth-сессию или пройдите вход заново. Для серверной автоматизации без браузера используйте [API-ключ](/ru/developers/rest/authentication). ### Сервер возвращает 403 Подключение действует, но роль в пространстве не разрешает операцию. Попросите владельца пространства выполнить действие или выдать подходящий доступ. Если проверка не помогла, откройте поддержку через кнопку в верхней панели документации. Приложите название клиента, текст ошибки и время запроса. Не отправляйте токены и ключи. --- # Навыки Viralmaxing для агентов locale: ru routePath: /ru/developers/mcp/skills Описание: Пять готовых навыков и коннектор одной командой: npx skills add Viralmaxing/skill. # Навыки Viralmaxing для агентов Коннектор даёт агенту инструменты. Навыки объясняют, **как ими пользоваться**: с чего начинать разбор аккаунта, чем отличается исследование от чтения плана, какие вызовы стоят энергии и когда спрашивать разрешение. Репозиторий публичный и собирается из исходников продукта, поэтому расходится с ним он не может: [Viralmaxing/skill](https://github.com/Viralmaxing/skill). ## Установка ```bash npx skills add Viralmaxing/skill ``` Одна команда ставит и навыки, и сам MCP-сервер: репозиторий оформлен по спецификации Agent Plugins: `skills/` для навыков, `mcp.json` для коннектора. Отдельно добавлять сервер после этого не нужно. Если нужен только коннектор, без навыков: ```bash claude mcp add --transport http --scope project viralmaxing https://api.viralmaxing.com/api/mcp ``` ## Что внутри | Навык | Для чего | | --- | --- | | `viralmaxing-analytics` | Метрики отслеживаемых аккаунтов: просмотры, вовлечение, динамика | | `viralmaxing-research` | Сравнение с конкурентами, поиск новых аккаунтов и идей | | `viralmaxing-video` | Транскрипт и разбор конкретного ролика | | `viralmaxing-plan` | Контент-план: взять видео в работу, написать и передвинуть сценарий | | `viralmaxing-automations` | Воронки «кодовое слово → Direct» в Instagram | Навыки разделены по задачам намеренно: агент подгружает только тот, который нужен запросу, и не тратит контекст на остальные. ## Вход и деньги Навыки не содержат секретов. Авторизация: через OAuth в браузере, как и у самого коннектора: см. [Быстрый старт с MCP](/developers/mcp/quick-start). Платные действия навыки не выполняют молча: инструмент называет цену и ждёт подтверждения. Что сколько стоит: в [справочнике по энергии](/docs/reference/energy). --- # Быстрый старт с REST API locale: ru routePath: /ru/developers/rest/quick-start Описание: Создайте API-ключ, сохраните его в переменной окружения и выполните первый запрос. # Быстрый старт с REST API REST API подходит для серверных интеграций, отчётов и внутренних инструментов. Для AI-клиента с человеком у экрана обычно проще [MCP](/ru/developers/mcp/quick-start). ## 1. Создайте ключ Откройте [Настройки → API-ключи](/settings/api), нажмите «Создать» и задайте понятное имя. Скопируйте полный ключ сразу. После закрытия окна он больше не показывается. ## 2. Сохраните секрет Положите ключ в переменную окружения, а не в исходный код: ```bash export VIRALMAXING_API_KEY='vmx_...' ``` Не коммитьте `.env` и не передавайте ключ в URL. ## 3. Выполните запрос ```bash curl --request GET \ --url https://api.viralmaxing.com/api/users/api-keys/ \ --header "X-API-Key: $VIRALMAXING_API_KEY" ``` Запрос возвращает список ключей без их секретных значений. Ответ `200` подтверждает, что ключ принят. Базовый адрес API: ```text https://api.viralmaxing.com/api ``` Откройте [API Reference](https://docs.viralmaxing.com), чтобы выбрать метод и увидеть его параметры. --- # Авторизация REST API locale: ru routePath: /ru/developers/rest/authentication Описание: Как передавать ключ, хранить его и отзывать без утечки секретов. # Авторизация REST API API-ключ начинается с `vmx_` и даёт доступ к одному пространству. Передавайте его в каждом запросе одним из двух способов. ## Заголовок X-API-Key ```http X-API-Key: vmx_... ``` Это основной и наиболее явный вариант. ## Bearer ```http Authorization: Bearer vmx_... ``` Оба заголовка принимаются одинаково. Не передавайте их одновременно. ## Хранение и ротация - храните ключ в менеджере секретов или переменной окружения; - создавайте отдельный ключ для каждой интеграции; - проверяйте дату последнего использования в настройках; - удаляйте ключ при утечке, смене владельца или остановке интеграции. Удаление отзывает доступ немедленно. Если приложение потеряло ключ, восстановить его значение нельзя. Создайте новый и удалите старый. Не вставляйте ключ в клиентский JavaScript, мобильное приложение или публичный репозиторий. Запросы с секретом должны идти с вашего сервера. ## Ошибки доступа `401` означает, что ключ отсутствует, недействителен, истёк или отозван. `403` означает, что ключ принят, но роль пользователя в пространстве не разрешает операцию. --- # Первый REST-запрос locale: ru routePath: /ru/developers/rest/first-request Описание: Проверьте ключ через cURL или JavaScript и разберите типовые ответы API. # Первый REST-запрос Начните с чтения. Такой запрос проверяет авторизацию и не меняет данные пространства. ## cURL ```bash curl --request GET \ --url https://api.viralmaxing.com/api/analytics/accounts/ \ --header "X-API-Key: $VIRALMAXING_API_KEY" \ --header "Accept: application/json" ``` ## JavaScript на сервере ```js const response = await fetch('https://api.viralmaxing.com/api/analytics/accounts/', { headers: { Accept: 'application/json', 'X-API-Key': process.env.VIRALMAXING_API_KEY, }, }); if (!response.ok) { throw new Error(`Viralmaxing API returned ${response.status}`); } const accounts = await response.json(); ``` ## Как читать ответ - `200` означает, что запрос выполнен; - `400` указывает на неверные параметры или бизнес-ограничение; - `401` просит заменить или добавить ключ; - `403` указывает на недостаточную роль; - `429` требует паузы перед повтором. Не повторяйте запрос без изменений после `400`. Прочитайте тело ошибки и исправьте параметры. Для `429` используйте задержку с увеличением интервала. Все доступные пути и структуры ответов находятся в [API Reference](https://docs.viralmaxing.com).