Команды flows

Флоу — это пейволы и онбординги, которые вы создаёте в Flow & Paywall Builder. CLI управляет записью флоу, его конфигом для билдера, публикацией и историей версий. Конфиг билдера — это большой JSON-документ, который обычно генерирует Flow & Paywall Builder; CLI его не создаёт. Чтобы создавать или редактировать конфиг из терминала, используйте скилл flow-generator, который управляет этими командами за вас. Перед публикацией скилл flow-audit проверяет, готов ли флоу к продакшену. Команды flows metrics читают данные страницы метрик флоу и требуют CLI версии 0.15.0 или выше. Команды flows funnel читают воронку флоу и требуют CLI версии 0.19.0 или выше. Команды перечислены здесь в качестве справочника.

adapty flows list

Показывает список всех флоу для приложения.

adapty flows list --app <app-id>
ФлагОбязательныйОписание
--appДаID приложения (UUID)

Принимает флаги пагинации.

adapty flows get

Получить детали конкретного флоу.

adapty flows get --app <app-id> <flow-id>
АргументОписание
flow-idID флоу (UUID)
ФлагОбязательныйОписание
--appДаID приложения (UUID)

Ответ содержит id, name, status, published_flow_version_id и updated_at. published_flow_version_id — это ID активной версии или null, если флоу ни разу не публиковался. Возможные значения статуса:

СтатусЗначение
draftФлоу ещё ни разу не публиковался
publishedТекущая версия активна
dirtyФлоу публиковался ранее, и текущая версия содержит неопубликованные изменения. Пользователи видят последнюю опубликованную версию
publishingПубликация выполняется
publication_failedПоследняя публикация завершилась с ошибкой. Исправьте конфигурацию и опубликуйте снова
archivedФлоу заархивирован

adapty flows create

Создать флоу. Новый флоу имеет название, но не имеет конфигурации. Чтобы добавить конфигурацию, используйте flows config update.

adapty flows create --app <app-id> --name "Onboarding"
ФлагОбязателенОписание
--appДаID приложения (UUID)
--nameДаНазвание флоу

adapty flows update

Переименовать флоу.

adapty flows update --app <app-id> <flow-id> --name "Onboarding v2"
ArgumentDescription
flow-idFlow ID (UUID)
FlagRequiredDescription
--appYesApp ID (UUID)
--nameYesНовое имя флоу

adapty flows publish

Опубликовать текущую версию флоу для ваших пользователей.

adapty flows publish --app <app-id> <flow-id>
АргументОписание
flow-idID флоу (UUID)
ФлагОбязательныйОписание
--appДаID приложения (UUID)
--yes, -yНетОпубликовать без запроса подтверждения. Обязателен, если вывод передаётся по пайпу или используется --json

Поскольку публикация меняет то, что видят пользователи, команда выводит имя флоу и запрашивает подтверждение. Любой ответ, кроме y, отменяет команду с кодом выхода 1. При использовании флага --json или в пайпе команда отказывается выполняться с кодом выхода 2 вместо ожидания ответа, поэтому в скриптах и агентских сессиях передавайте --yes.

Публикация выполняется асинхронно: в ответе возвращается status: publishing, и флоу ещё не активен. Опрашивайте flows get до тех пор, пока статус не станет published или publication_failed. При publication_failed причину можно узнать через flows config get.

Публикация завершается с HTTP 400, если у флоу нет конфига, конфиг не готов к публикации или текущая версия уже активна. Чтобы проверить конфиг перед публикацией, используйте flows config validate.

adapty flows config get

Получить конфигурацию конструктора для флоу.

adapty flows config get --app <app-id> <flow-id>
АргументОписание
flow-idID флоу (UUID)
ФлагОбязательныйОписание
--appДаID приложения (UUID)

Ответ содержит поля config, remote_configs, status и updated_at. updated_at — это метка времени в миллисекундах, соответствующая последнему изменению конфига. Передайте её в flows config update через --expected-updated-at, чтобы не затереть параллельно сделанные правки. Если конфиг флоу ни разу не записывался, возвращается 404.

После попытки публикации ответ также содержит три поля, описывающие её результат. Читайте их, когда flows get возвращает publication_failed:

ПолеОписание
publication_statusСтатус публикации данной версии флоу: transforming, transformed, uploading, uploaded, published или failed
transform_errorНеобработанная ошибка трансформации — либо JSON-пейлоад с описанием проблем, либо строка с кратким описанием
publication_errorПонятное сообщение об ошибке публикации

adapty flows config update

Запишите конфигурацию билдера флоу и его Remote Config.

adapty flows config get --app <app-id> <flow-id> --json > flow.json
adapty flows config update --app <app-id> <flow-id> --file flow.json
АргументОписание
flow-idID флоу (UUID)
ФлагОбязательныйОписание
--appДаID приложения (UUID)
--fileВместо --config, --config-file и --remote-configsПуть к JSON-файлу с полями config и remote_configs, или - для чтения из stdin. Вывод команды flows config get --json подходит как есть. Остальные ключи игнорируются
--configБез --file: один из --config и --config-fileКонфигурация билдера в виде JSON-строки
--config-fileБез --file: один из --config и --config-fileПуть к JSON-файлу с конфигурацией билдера, или - для чтения из stdin
--remote-configsБез --fileJSON-массив записей {locale, data}, где data — Remote Config в виде строки. [] удаляет все Remote Config
--expected-updated-atНетЗначение updated_at из предыдущего вызова flows config get. Если конфигурация изменилась после этого чтения, команда завершится с ошибкой вместо того, чтобы перезаписать изменения. Опустите этот флаг, чтобы перезаписывать безусловно

Запись заменяет конфиг и весь список Remote Config’ов. Чтобы сохранить Remote Config’и, передайте remote_configs из flows config get --json. Без --file команда требует одновременно и конфиг, и --remote-configs: если один из них отсутствует, она завершается с кодом 2 и не отправляет запрос. Флаг --file и обязательный --remote-configs требуют CLI версии 0.20.0 или выше.

Чтобы записать первый конфиг нового флоу, передайте пустой список Remote Config’ов:

adapty flows config update --app <app-id> <flow-id> --config-file config.json --remote-configs '[]'

Сохранение конфига создаёт черновик, но не публикует его. Для опубликованного флоу запись создаёт новую версию: статус флоу становится dirty, и пользователи видят опубликованную версию до тех пор, пока вы не выполните flows publish.

adapty flows config validate

Проверяет, готова ли конфигурация билдера к публикации, без её сохранения.

adapty flows config validate --app <app-id> <flow-id> --config-file config.json
АргументОписание
flow-idID флоу (UUID)
ФлагОбязателенОписание
--appДаID приложения (UUID)
--configОдин из двухКонфигурация билдера в виде JSON-строки
--config-fileОдин из двухПуть к JSON-файлу с конфигурацией билдера или - для чтения из stdin

Ответ содержит valid и список issues. Если конфиг нельзя опубликовать, команда завершается с кодом 1, что позволяет использовать это в скриптах.

adapty flows config preview

Отображает локальный файл конфигурации в браузере. Эта команда не обращается к API и не принимает флаг --app.

adapty flows config preview ./config.json --screen <screen-id> --device iphone-14 --orientation portrait
АргументОписание
config-fileПуть к локальному файлу JSON с конфигурацией билдера
ФлагПо умолчаниюОписание
--screenПервый экран флоуID экрана для отображения
--deviceiphone-14Фрейм устройства для отображения
--orientationportraitportrait или landscape

В терминале команда открывает превью в браузере. При перенаправлении вывода или с флагом --json она печатает URL. URL содержит полный конфиг и может быть длинным: передайте его в инструмент для скриншотов, а не выводите напрямую. Конфиги размером более ~32 КБ отображаются медленно.

adapty flows media upload

Загрузка изображения для использования в конфигурации флоу.

adapty flows media upload --app <app-id> ./hero.png
ArgumentDescription
filePath to the image file
FlagRequiredDescription
--appYesApp ID (UUID)

Допустимые форматы: PNG, JPEG, WebP и SVG. Ответ содержит id, name изображения и CDN url для ссылки из конфига. Чтобы загрузить видео, используйте flows media upload-video.

adapty flows media upload-video

Загрузить видео для использования в конфигурации флоу.

adapty flows media upload-video --app <app-id> ./intro.mp4
ArgumentDescription
filePath to the video file
FlagRequiredDescription
--appYesApp ID (UUID)

Допустимые форматы: MP4 и WebM. Видео должно быть не длиннее 30 секунд и не более 50 МБ, а ширина и высота — не менее 640 пикселей каждая. GIF не поддерживается; команда не конвертирует анимированные изображения в видео.

Ответ содержит URL видео (HLS-плейлист), URL превью-изображения, а также width и height видео. В конфиге элемент видео принимает их как videoUrl, previewUrl, width и height.

adapty flows versions list

Список версий флоу в обратном хронологическом порядке (сначала новые). Это версии из истории версий в Flow & Paywall Builder.

adapty flows versions list --app <app-id> <flow-id>
АргументОписание
flow-idID флоу (UUID)
ФлагОбязателенОписание
--appДаID приложения (UUID)
--searchНетПоказать только версии, в названии которых есть указанный текст. Регистр не важен, поиск по части слова: friday найдёт Black Friday

Каждая строка показывает название, статус, дату и ID версии. Название — это имя версии, или Version N, если имя не задано. Статус принимает одно из следующих значений:

СтатусЗначение
draftВерсия, которую вы редактируете. У флоу может быть один черновик или ни одного. Пока черновик публикуется, строка заканчивается на Publishing…, а если публикация завершилась с ошибкой — на Publish failed
liveВерсия, которую видят ваши пользователи
previousБолее ранняя версия. Она была активна раньше, или её вытеснила новая версия до публикации

Дата live или previous версии — это дата начала публикации. Для черновика, а также для previous версии, которая никогда не публиковалась, это дата создания версии.

Для флоу, который ни разу не публиковался, команда выводит History will appear after the first publish. и строку черновика под ней. История версий в дашборде не показывает ни одной строки для такого флоу. Если ни одна версия не соответствует --search, команда выводит No versions match the search.

Команда всегда выводит все версии и не поддерживает флаги пагинации.

С флагом --json команда выводит {data, meta} от Adapty без изменений, строки находятся в data. Каждая строка содержит поля flow_version_id, version, name, title, state, is_current, publication_status, published_at, created_at, updated_at и last_edited_by. updated_at — миллисекундный таймстамп последнего изменения содержимого версии: передайте updated_at черновика в flows versions restore через флаг --expected-updated-at. last_edited_by содержит имя пользователя, который последним изменил версию, или null, если Adapty не знает этого пользователя.

adapty flows versions get

Читает одну версию флоу. Чтение версии ничего не меняет: черновик и опубликованная версия остаются как есть.

Команда выводит название, ID, номер, статус и дату версии, пользователя, который последним вносил изменения, и ссылку Test on device. Полное содержимое версии — конфигурация билдера со всеми макетами, Remote Config и пейволы — доступно в выводе --json и в файле --output.

adapty flows versions get --app <app-id> <flow-id> <version-id> --output version.json
АргументОписание
flow-idID флоу (UUID)
version-idID версии (UUID), из flows versions list
ФлагОбязательныйОписание
--appДаID приложения (UUID)
--outputНетЗаписать полное содержимое версии в этот файл в формате JSON
--yes, -yНетЗаменить существующий файл --output без запроса подтверждения. Обязательно при использовании --json или в пайпе, если файл уже существует

Если CLI не может записать файл --output — например, если папка не существует — команда выводит Could not write <path> (<errno>). и завершается с кодом 1.

adapty flows versions preview

Выводит ссылку Test on device для указанной версии. Откройте ссылку на тестовом устройстве, чтобы просмотреть версию в мобильном приложении Adapty. Подходит любая версия: черновик, активная или более ранняя.

adapty flows versions preview --app <app-id> <flow-id> <version-id>
АргументОписание
flow-idID флоу (UUID)
version-idID версии (UUID)
ФлагОбязательныйОписание
--appДаID приложения (UUID)

adapty flows versions rename

Переименовать версию. Можно переименовать черновик, текущую боевую версию и более ранние версии.

adapty flows versions rename --app <app-id> <flow-id> <version-id> --name "Black Friday"
АргументОписание
flow-idID флоу (UUID)
version-idID версии (UUID)
ФлагОбязателенОписание
--appДаID приложения (UUID)
--nameДаНовое название версии. Передайте --name "", чтобы удалить название — тогда версия снова будет отображаться как Version N. Название, состоящее только из пробелов, также удаляет его

Команда выводит идентификатор версии и новое название. Adapty обрезает пробелы в начале и конце названия. Две версии могут иметь одинаковое название. Переименование не изменяет содержимое версии и её поле updated_at, поэтому не конфликтует с последующим сохранением черновика.

adapty flows versions restore

Восстановить версию как черновик того же флоу. Это действие Duplicate as draft в истории версий. Восстановленная версия не станет доступна пользователям, пока вы не опубликуете её.

Tip

Восстановление заменяет текущий черновик. Чтобы сохранить черновик, сначала продублируйте его в новый флоу с помощью flows duplicate.

adapty flows versions restore --app <app-id> <flow-id> <version-id>
АргументОписание
flow-idID флоу (UUID)
version-idID версии (UUID) для версии в статусе live или previous
ФлагОбязательныйОписание
--appДаID приложения (UUID)
--expected-updated-atС --yes, если у флоу есть черновикЗначение updated_at черновика, полученное из flows versions list --json. Если черновик был изменён после этого чтения, команда завершится с ошибкой вместо того, чтобы перезаписать изменение
--yes, -yНетЗаменить черновик без подтверждения. Обязателен с --json или при использовании в пайпе, если у флоу есть черновик

Команда сначала считывает версии флоу:

  • У флоу нет черновика: команда ничего не спрашивает. Adapty создаёт новый черновик со следующим номером версии, без имени и с содержимым выбранной версии. Живая версия и та, которую вы восстанавливаете, остаются без изменений.
  • У флоу есть черновик: команда спрашивает Replace the draft '<draft>' (last change <time> by <user>) with '<version>'? To keep the draft, duplicate it to a new flow first., затем Apply? [y/N]. Если вы ответите y, черновик сохранит свой ID, номер и имя, но получит содержимое выбранной версии. Новая версия не создаётся. Любой другой ответ завершает команду с кодом 1 и ничего не отправляет.

При использовании --json, в пайпе или без терминала команда не может задавать вопросы. Если у флоу есть черновик, команда ничего не отправляет и завершается с кодом 6, если не передан флаг --yes. Сообщение содержит вопрос и добавляет To replace it, re-run with --yes --expected-updated-at <ms> (the draft's updated_at)., где вместо <ms> подставляется значение updated_at черновика. При использовании --yes также необходимо передать --expected-updated-at: без него команда завершается с кодом 6 и ничего не отправляет. В терминале без --expected-updated-at команда берёт значение updated_at черновика, который показывает в вопросе.

После восстановления команда выводит Restored '<version>' as the draft '<draft>' (<draft-id>). Nothing is published.

Adapty отклоняет восстановление и не вносит никаких изменений в следующих случаях. Команда выводит сообщение Adapty, в некоторых случаях добавляет инструкцию по дальнейшим действиям и завершается с кодом 4:

СообщениеЧто делать
This flow version is already the current draft.Выберите другую версию.
Flow version does not exist.Такого ID версии нет в списке версий этого флоу. Возьмите ID из flows versions list.
Flow version is already being published.Дождитесь окончания публикации, затем попробуйте восстановить снова.
This flow version uses deleted products: …Выберите версию, которая не использует удалённые продукты.
This flow configuration was already updated by …Коллега изменил черновик после того, как вы его прочитали. Обновите список версий и повторите попытку.
Flow is deleted.Флоу архивирован. Сначала восстановите его из архива в дашборде.

adapty flows duplicate

Копирует флоу или одну из его версий в новый флоу. Это действие соответствует Duplicate flow в меню действий флоу на верхней панели Flow & Paywall Builder (см. Копирование флоу), а также Duplicate as new flow в истории версий.

adapty flows duplicate --app <app-id> <flow-id> --version <version-id>
АргументОписание
flow-idID флоу (UUID)
ФлагОбязательныйОписание
--appДаID приложения (UUID)
--versionНетID версии (UUID) для копирования, из flows versions list. Подходит любая версия, включая черновик. Без этого флага команда копирует черновик или опубликованную версию, если черновика нет

Команда выводит New flow '<name>' (<flow-id>), not published. Новый флоу получает имя исходного с суффиксом _copy. Он не опубликован и содержит один черновик с содержимым версии. Исходный флоу, его черновик и история остаются без изменений. Дублировать флоу можно даже в процессе публикации.

Adapty отказывает в копировании версии, если она использует удалённый продукт, а также не позволяет копировать архивный флоу. Сообщения об ошибках такие же, как для flows versions restore.

adapty flows metrics list

Показывает накопленные метрики нескольких флоу — по одной строке на каждый флоу. Это данные из таблицы флоу на дашборде.

adapty flows metrics list --app <app-id> --ids <flow-id>,<flow-id>
ФлагОбязательныйОписание
--appДаID приложения (UUID)
--idsДаID флоу (UUID). Разделяйте запятыми или повторяйте флаг
--csvНетВывод в формате CSV: одна строка на каждый флоу с его ID и всеми 27 метриками. Нельзя использовать вместе с --json

Каждая строка показывает ID флоу вместе с просмотрами, покупками, пробными периодами и выручкой. Флаги --json и --csv включают все 27 метрик со страницы метрик флоу, таких как unique_profiles_views, net_revenue и conversion_rate_purchases. Метрика без данных равна 0, но никогда не null. Для каждого флоу, который ни разу не был опубликован, команда выводит под таблицей <flow-id>: No data: the flow was never published.. При использовании --json в строку такого флоу добавляется note: "never_published", а при --csv примечания выводятся в stderr, чтобы CSV оставался чистым.

Значения метрик флоу Adapty

Выводит список ключей и значений фильтров флоу — то, что принимает flows metrics get --filter.

adapty flows metrics values --app <app-id> <flow-id>
АргументОписание
flow-idID флоу (UUID)
ФлагОбязателенОписание
--appДаID приложения (UUID)

Каждая строка показывает метку и, в скобках, значение для передачи. Значения вложены так же, как фильтры на дашборде:

Country (country)
  Americas (Americas)
    United States (US)
  Europe (Europe)
    Germany (DE)
Store (store)
  App Store (app_store)
  Google Play (play_store)

Верхнее значение каждой группы — это ключ фильтра, а самые вложенные значения — то, что этот ключ принимает. В примере --filter country=US оставляет только США, а --filter store=play_store — только Google Play.

adapty flows metrics get

Показывает метрики одного флоу за период в виде дерева, как на странице метрик флоу.

adapty flows metrics get --app <app-id> <flow-id> --date-from 2026-09-01 --date-to 2026-10-21 --date-type purchase_date --based-on placement
АргументОписание
flow-idID флоу (UUID)
ФлагОбязательныйОписание
--appДаID приложения (UUID)
--based-onДаПо чему строится первый уровень дерева: placement или audience. Это представления страницы метрик флоу — по плейсментам или по аудиториям
--date-typeДаКакая дата применяется к периоду: purchase_date или profile_install_date для фильтрации по дате установки
--date-fromНетПервый день периода включительно (YYYY-MM-DD). Передаётся вместе с --date-to
--date-toНетПоследний день периода включительно (YYYY-MM-DD). Передаётся вместе с --date-from
--granularityНетРазбивка периода на точки: day, week, month, quarter или year
--filterНетОставить только данные с указанными значениями ключа фильтра. Можно передавать несколько раз. См. Фильтрация метрик
--timezoneНетЧасовой пояс IANA для точек периода, например Europe/Berlin. Если не указан, Adapty использует часовой пояс приложения
--depthНетСколько уровней дерева выводить под Total. По умолчанию: 1
--csvНетВывести CSV: одна строка на каждый узел дерева. Нельзя использовать вместе с --json

Для флоу, который ни разу не публиковался, команда выводит над числами пометку No data: the flow was never published., а --json добавляет note: "never_published". При использовании --csv пометка выводится в stderr, так что CSV остаётся чистым.

Чтобы получить доход по конкретному флоу, выполните adapty analytics chart --app <app-id> --chart revenue --date-from <YYYY-MM-DD> --date-to <YYYY-MM-DD> --filter flow_id=<flow-id>. См. Команды аналитики.

CLI завершается с кодом 2 и не отправляет запрос, если отсутствует --based-on или --date-type, либо указан только один конец периода. Adapty валидирует значения --based-on, --date-type и --granularity: неверное значение завершает выполнение с кодом 4, а в сообщении об ошибке перечислены допустимые значения.

Читаем вывод

Команда выводит строку Total, затем первый уровень дерева под ней. В каждой строке отображаются просмотры, покупки, триалы и выручка. При использовании --granularity точки периода выводятся прямо под своим узлом:

Total           views 19  purchases 7  trials 4  revenue 241.93
  Onboarding    views 10  purchases 7  trials 0  revenue 241.93
    2026-09-01  views  0  purchases 0  trials 0  revenue   0.00
    2026-10-01  views 10  purchases 0  trials 0  revenue 241.93
  Settings      views  0  purchases 0  trials 0  revenue   0.00

Уровни дерева соответствуют уровням дашборда: плейсмент, аудитория, A/B-тест, вариант флоу, экран и продукт. С флагом --based-on audience уровень плейсмента не отображается. Чтобы вывести больше уровней, передайте --depth, например --depth 3.

Для полного дерева со всеми 27 метриками используйте один из этих флагов:

  • --json печатает ответ сервера без изменений.
  • --csv печатает по одной строке для каждого узла, включая точки периодов. Столбцы: path (заголовки от Total до узла, разделённые >), level, title, и затем метрики.

Фильтрация метрик

Каждый --filter записывается в формате key=value, где ключи и значения перечислены в flows metrics values. Чтобы оставить несколько значений по одному ключу, перечислите их через запятую или повторите флаг с тем же ключом. Фильтры с разными ключами комбинируются, и данные должны соответствовать всем из них:

adapty flows metrics get --app <app-id> <flow-id> --date-from 2026-09-01 --date-to 2026-10-21 \
  --date-type purchase_date --based-on placement --filter country=US,DE --filter store=app_store

CLI отправляет каждое значение ровно так, как оно написано. Чтобы вставить запятую в значение, напишите \,. Пустое значение — тоже значение: attribution_channel= сохраняет данные без указания канала, а flows metrics values отображает его как No Data.

adapty flows funnel values

Список ключей и значений фильтров воронки флоу: то, что принимает flows funnel get --filter.

adapty flows funnel values --app <app-id> <flow-id>
АргументОписание
flow-idID флоу (UUID)
ФлагОбязательныйОписание
--appДаID приложения (UUID)

Вывод имеет ту же форму, что и flows metrics values.

adapty flows funnel get

Показывает экран, на котором пользователи покидают флоу: воронка одной версии флоу, шаг за шагом и экран за экраном — как на вкладке Funnel флоу.

adapty flows funnel get --app <app-id> <flow-id> --date-from 2026-09-01 --date-to 2026-10-21 --date-type purchase_date
АргументОписание
flow-idID флоу (UUID)
ФлагОбязательныйОписание
--appДаID приложения (UUID)
--date-fromДаПервый день периода включительно (YYYY-MM-DD), в часовом поясе --timezone или часовом поясе приложения
--date-toДаПоследний день периода включительно (YYYY-MM-DD), в часовом поясе --timezone или часовом поясе приложения
--date-typeДаК какой дате применяется период: purchase_date или profile_install_date
--flow-version-idНетID версии флоу (UUID) для чтения. Без него CLI читает опубликованную версию
--filterНетОставить только пользователей с указанными значениями ключа фильтра в формате key=value. Можно указывать несколько раз. Ключи и значения берутся из flows funnel values и работают как в разделе Фильтрация метрик
--timezoneНетЧасовой пояс IANA для дней, например Europe/Berlin. Без него Adapty использует часовой пояс приложения
--csvНетВыводит CSV-файл, который скачивает дашборд, с итоговой строкой первой. Нельзя использовать вместе с --json

Команда выводит версию флоу и период, итоговую строку и таблицу. В итоговой строке показано, сколько пользователей вошло во флоу, сколько завершило его, показатель отсева и выручка. В таблице — по одной строке на каждый шаг, со столбцами Step, Type, Reached, Completed, Drop rate и Revenue. Шаг с несколькими экранами также получает по одной строке на каждый экран. Значение, которое неприменимо, — например, выручка от экрана онбординга, — отображается как —.

When no users entered the flow in the period, the table lists the screens of the version with zeros. For every field of the answer, use --json.

Что дальше