Flows コマンド
フローは、フロー&ペイウォールビルダーで作成するペイウォールやオンボーディングです。CLIはフローのレコード、ビルダーの設定、公開、およびバージョン履歴を管理します。ビルダーの設定は、フロー&ペイウォールビルダーが通常生成する大きなJSONドキュメントであり、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-id | フロー ID (UUID) |
| フラグ | 必須 | 説明 |
|---|---|---|
--app | Yes | アプリ 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 | Yes | アプリ ID(UUID) |
--name | Yes | フロー名 |
adapty flows update
フローの名前を変更します。
adapty flows update --app <app-id> <flow-id> --name "Onboarding v2"
| 引数 | 説明 |
|---|---|
flow-id | フロー ID(UUID) |
| フラグ | 必須 | 説明 |
|---|---|---|
--app | Yes | アプリ ID(UUID) |
--name | Yes | 新しいフロー名 |
adapty flows publish
フローの現在のバージョンをユーザーに公開します。
adapty flows publish --app <app-id> <flow-id>
| 引数 | 説明 |
|---|---|
flow-id | フロー ID(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-id | フロー ID(UUID) |
| フラグ | 必須 | 説明 |
|---|---|---|
--app | はい | アプリ ID(UUID) |
レスポンスには config、remote_configs、status、updated_at が含まれます。updated_at は最後にコンフィグが変更されたときのミリ秒タイムスタンプです。同時編集による上書きを防ぐために、これを flows config update の --expected-updated-at として渡してください。コンフィグが一度も書き込まれていないフローは 404 を返します。
パブリッシュを試みた後、レスポンスにはその結果を示す 3 つのフィールドも含まれます。flows get が publication_failed を返した場合はこれらを確認してください:
| フィールド | 説明 |
|---|---|
publication_status | このフローバージョンの公開がどの段階まで進んだか: transforming、transformed、uploading、uploaded、published、または failed |
transform_error | 変換失敗の生データ — 問題を列挙した JSON ペイロード、またはサマリー文字列 |
publication_error | 公開失敗時の読みやすいエラーメッセージ |
adapty flows config update
フローのビルダーコンフィグとリモートコンフィグを書き込みます。
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-id | フロー ID (UUID) |
| フラグ | 必須 | 説明 |
|---|---|---|
--app | はい | アプリID(UUID) |
--file | --config、--config-file、--remote-configs の代わりに使用 | config と remote_configs を含むJSONファイルへのパス、またはstdinから読み取る場合は -。flows config get --json の出力をそのまま使用可能。その他のキーは無視される |
--config | --file なしの場合:--config と --config-file のいずれか | JSON文字列としてのビルダーコンフィグ |
--config-file | --file なしの場合:--config と --config-file のいずれか | ビルダーコンフィグを含むJSONファイルへのパス、またはstdinから読み取る場合は - |
--remote-configs | --file なしの場合 | {locale, data} エントリのJSON配列。data は文字列としてのリモートコンフィグ。[] を指定するとすべてのリモートコンフィグが削除される |
--expected-updated-at | いいえ | 以前の flows config get から取得した updated_at の値。その読み取り以降にコンフィグが変更された場合、変更を上書きせずにコマンドが失敗する。無条件に上書きする場合は省略 |
書き込みを行うと、コンフィグとリモートコンフィグのリスト全体が置き換えられます。リモートコンフィグを保持するには、flows config get --json から取得した remote_configs を送信してください。--file を指定しない場合、コマンドにはコンフィグと --remote-configs の両方が必要です。どちらかが欠けている場合、コード 2 で終了しリクエストは送信されません。--file フラグと必須の --remote-configs を使用するには CLI バージョン 0.20.0 以降が必要です。
新しいフローの最初のコンフィグを書き込むには、空のリモートコンフィグのリストを渡します:
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-id | フロー ID(UUID) |
| フラグ | 必須 | 説明 |
|---|---|---|
--app | はい | アプリ ID(UUID) |
--config | どちらか一方 | JSON 文字列としてのビルダーコンフィグ |
--config-file | どちらか一方 | ビルダーコンフィグが記載された JSON ファイルへのパス、または標準入力から読み込む場合は - |
レスポンスには 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 |
--device | iphone-14 | レンダリングに使用するデバイスフレーム |
--orientation | portrait | portrait または landscape |
ターミナルでこのコマンドを実行すると、ブラウザでプレビューが開きます。パイプや --json オプションを使うと、代わりに URL が出力されます。URL にはコンフィグ全体が含まれるため非常に長くなります。表示するのではなく、スクリーンショットツールにパイプして使用してください。コンフィグが約 32 KB を超えると、レンダリングが遅くなります。
adapty flows media upload
フローのコンフィグで使用する画像をアップロードします。
adapty flows media upload --app <app-id> ./hero.png
| 引数 | 説明 |
|---|---|
file | 画像ファイルへのパス |
| フラグ | 必須 | 説明 |
|---|---|---|
--app | Yes | アプリ 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
| 引数 | 説明 |
|---|---|
file | 動画ファイルのパス |
| フラグ | 必須 | 説明 |
|---|---|---|
--app | Yes | アプリID(UUID) |
対応フォーマット:MP4およびWebM。動画は最大30秒、最大50MB、幅と高さはそれぞれ640ピクセル以上である必要があります。GIFはサポートされておらず、このコマンドはアニメーション画像を動画に変換しません。
レスポンスには、動画のURL(HLSプレイリスト)、プレビュー画像のURL、動画のwidthとheightが含まれています。コンフィグでは、動画要素がこれらをvideoUrl、previewUrl、width、heightとして受け取ります。
adapty flows versions list
フローのバージョン一覧を新しい順に表示します。これらはフロー & ペイウォールビルダーのバージョン履歴に対応するバージョンです。
adapty flows versions list --app <app-id> <flow-id>
| 引数 | 説明 |
|---|---|
flow-id | フロー ID(UUID) |
| フラグ | 必須 | 説明 |
|---|---|---|
--app | Yes | アプリ ID(UUID) |
--search | No | タイトルに指定したテキストを含むバージョンのみ表示します。大文字・小文字を区別せず、部分一致も有効です(例:friday と入力すると Black Friday がヒットします)。 |
各行には、バージョンのタイトル、状態、日付、IDが表示されます。タイトルはバージョン名、または名前がない場合は Version N となります。状態は次のいずれかです:
| 状態 | 意味 |
|---|---|
draft | 編集中のバージョン。フローには1つのドラフトがあるか、ドラフトなしの状態です。ドラフトの公開中は行の末尾に Publishing… と表示され、公開に失敗した場合は Publish failed と表示されます |
live | ユーザーに表示されているバージョン |
previous | 以前のバージョン。過去に公開されていたか、公開前に新しいバージョンに置き換えられたものです |
live または previous バージョンの日付は、そのバージョンの公開が開始された日付です。ドラフト、および一度も公開されていない previous バージョンの場合は、バージョンが作成された日付です。
一度も公開されていないフローの場合、コマンドは History will appear after the first publish. と表示し、その下にドラフト行を表示します。ダッシュボードのバージョン履歴には、そのようなフローの行は表示されません。--search に一致するバージョンがない場合、コマンドは No versions match the search. と表示します。
このコマンドは常にすべてのバージョンを一覧表示し、ページネーションフラグには対応していません。
--json を使用すると、コマンドは Adapty の {data, meta} をそのまま出力し、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 はそのバージョンを最後に変更したユーザー名を示し、Adapty がユーザーを特定できない場合は null になります。
adapty flows versions get
フローの1つのバージョンを取得します。バージョンの取得によって状態は変わりません。ドラフトとライブバージョンはそのままです。
このコマンドは、バージョンのタイトル、ID、番号、状態、日付、最後に変更したユーザー、および Test on device リンクを出力します。バージョンの完全なコンテンツ(すべてのレイアウトを含むビルダー設定、リモートコンフィグ、ペイウォール)は、--json の出力と --output のファイルに含まれます。
adapty flows versions get --app <app-id> <flow-id> <version-id> --output version.json
| 引数 | 説明 |
|---|---|
flow-id | フロー ID(UUID) |
version-id | バージョン ID(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-id | フロー ID(UUID) |
version-id | バージョン ID(UUID) |
| フラグ | 必須 | 説明 |
|---|---|---|
--app | Yes | アプリ ID(UUID) |
adapty flows versions rename
バージョンの名前を変更します。ドラフト、ライブバージョン、および以前のバージョンの名前を変更できます。
adapty flows versions rename --app <app-id> <flow-id> <version-id> --name "Black Friday"
| 引数 | 説明 |
|---|---|
flow-id | フロー ID(UUID) |
version-id | バージョン ID(UUID) |
| フラグ | 必須 | 説明 |
|---|---|---|
--app | Yes | アプリ ID(UUID) |
--name | Yes | 新しいバージョン名。--name "" を渡すと名前が削除され、バージョンが再び Version N と表示されます。スペースのみの名前も同様に削除されます |
このコマンドはバージョン ID と新しいタイトルを出力します。Adapty は名前の両端のスペースを削除します。2 つのバージョンが同じ名前を持つことができます。名前の変更はバージョンのコンテンツや updated_at を変更しないため、後でドラフトを保存する操作と競合しません。
adapty flows versions restore
同じフローのドラフトとしてバージョンを復元します。これはバージョン履歴の Duplicate as draft に相当します。復元されたバージョンは公開するまでユーザーには反映されません。
復元を行うと現在のドラフトが上書きされます。ドラフトを残したい場合は、先に flows duplicate で新しいフローとして複製してください。
adapty flows versions restore --app <app-id> <flow-id> <version-id>
| 引数 | 説明 |
|---|---|
flow-id | フローID(UUID) |
version-id | live または previous バージョンのバージョンID(UUID) |
| フラグ | 必須 | 説明 |
|---|---|---|
--app | はい | アプリID(UUID) |
--expected-updated-at | --yes を使用し、フローにドラフトがある場合 | flows versions list --json から取得したドラフトの updated_at。その読み取り後にドラフトが変更されていた場合、変更を上書きせずにコマンドが失敗します |
--yes, -y | いいえ | 確認なしでドラフトを置き換えます。フローにドラフトがある場合、--json 使用時またはパイプ実行時に必須です |
このコマンドはまず、フローのバージョンを読み込みます:
- フローにドラフトがない場合: コマンドは何も確認せず、次のバージョン番号・名前なし・そのバージョンの内容をすべて持つ新しいドラフトを作成します。ライブバージョンと復元元のバージョンはそのまま維持されます。
- フローにドラフトがある場合:
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を使用する場合、パイプ経由の場合、またはターミナルがない場合、コマンドは確認を求めることができません。フローにドラフトがある場合、--yesを渡さない限り、何も送信せずにコード6で終了します。メッセージは質問を表示し、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 がこのフローのバージョン一覧に存在しません。flows versions list から ID を取得してください。 |
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
フローまたはそのバージョンの1つを新しいフローにコピーします。これはフロー&ペイウォールビルダーのトップバーにあるフローアクションボタンの Duplicate flow 、およびバージョン履歴の Duplicate as new flow に対応しています(フローのコピーを参照)。
adapty flows duplicate --app <app-id> <flow-id> --version <version-id>
| 引数 | 説明 |
|---|---|
flow-id | フローID(UUID) |
| フラグ | 必須 | 説明 |
|---|---|---|
--app | はい | アプリ ID(UUID) |
--version | いいえ | コピーするバージョン ID(UUID)。flows versions list から確認できます。ドラフトを含む任意のバージョンを指定できます。省略した場合は、ドラフトをコピーします。ドラフトが存在しない場合はライブバージョンをコピーします |
このコマンドを実行すると、New flow '<name>' (<flow-id>), not published. と表示されます。新しいフローはコピー元のフロー名に _copy を付けた名前になります。未公開の状態で、そのバージョンの内容を持つドラフトが1つ作成されます。コピー元のフロー、そのドラフト、履歴はそのまま維持されます。公開中のフローも複製できます。
削除済みのプロダクトを使用しているバージョンのコピーや、アーカイブ済みフローのコピーはAdaptyに拒否されます。エラーメッセージは flows versions restore と同じです。
adapty flows metrics list
複数のフローのライフタイム指標を表示します(フローごとに1行)。これはダッシュボードのフローテーブルのデータです。
adapty flows metrics list --app <app-id> --ids <flow-id>,<flow-id>
| フラグ | 必須 | 説明 |
|---|---|---|
--app | はい | アプリID(UUID) |
--ids | はい | フローID(UUID)。カンマ区切りで指定するか、フラグを繰り返し使用します |
--csv | いいえ | CSVで出力します:フローIDと27個すべての指標を含む行をフローごとに1行出力します。--json と同時には使用できません |
各行には、フローID、ビュー数、購入数、トライアル数、収益が表示されます。--json および --csv オプションでは、unique_profiles_views、net_revenue、conversion_rate_purchases など、フロー指標ページに記載されている27の指標がすべて出力されます。データのない指標は null ではなく 0 として表示されます。一度も公開されたことのないフローについては、テーブルの下に <flow-id>: No data: the flow was never published. と表示されます。--json の場合はそのフローの行に note: "never_published" が追加されます。--csv の場合は、CSVをクリーンな状態に保つため、注記はstderrに出力されます。
adapty flows metrics values
フローのフィルターキーと値の一覧です。flows metrics get --filter に渡す値を確認できます。
adapty flows metrics values --app <app-id> <flow-id>
| 引数 | 説明 |
|---|---|
flow-id | フロー ID(UUID) |
| フラグ | 必須 | 説明 |
|---|---|---|
--app | Yes | アプリ 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-id | フローID(UUID) |
| フラグ | 必須 | 説明 |
|---|---|---|
--app | はい | アプリID(UUID) |
--based-on | はい | ツリーの第1レベルの分割基準: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はアプリのタイムゾーンをUseします |
--depth | いいえ | Totalの下に表示するツリーのレベル数。デフォルト:1 |
--csv | いいえ | CSV形式で出力します:ツリー全体の各ノードを1行で表示。--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> を実行してください。詳細はアナリティクスコマンドを参照してください。
--based-on、--date-type が指定されていない場合、または期間の片方のみが指定されている場合、CLIはリクエストを送信せずにコード2で終了します。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は各ノードを 1 行で出力し、ピリオドのポイントも含まれます。カラムは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-id | フロー ID(UUID) |
| フラグ | 必須 | 説明 |
|---|---|---|
--app | はい | アプリ ID(UUID) |
出力形式は flows metrics values と同じです。
adapty flows funnel get
フローのどの画面でユーザーが離脱するかを表示します。フローのファネルタブと同様に、1つのフローバージョンのファネルをステップごと・画面ごとに確認できます。
adapty flows funnel get --app <app-id> <flow-id> --date-from 2026-09-01 --date-to 2026-10-21 --date-type purchase_date
| 引数 | 説明 |
|---|---|
flow-id | フロー ID(UUID) |
| フラグ | 必須 | 説明 |
|---|---|---|
--app | Yes | アプリID(UUID) |
--date-from | Yes | 期間の開始日(含む)(YYYY-MM-DD)、--timezone またはアプリのタイムゾーン基準 |
--date-to | Yes | 期間の終了日(含む)(YYYY-MM-DD)、--timezone またはアプリのタイムゾーン基準 |
--date-type | Yes | 期間を適用する日付の種類:purchase_date または profile_install_date |
--flow-version-id | No | 読み込むフローバージョンID(UUID)。指定しない場合、CLIは公開済みバージョンを読み込む |
--filter | No | フィルターキーの値が一致するユーザーのみを保持する。key=value 形式で指定。繰り返し指定可能。キーと値は flows funnel values から取得し、Filter the metrics と同様に機能する |
--timezone | No | 日付のIANAタイムゾーン(例:Europe/Berlin)。指定しない場合、Adaptyはアプリのタイムゾーンを使用する |
--csv | No | ダッシュボードがダウンロードするCSVファイルを、合計行を先頭に出力する。--json との併用不可 |
コマンドはフローのバージョンと期間、サマリー行、そしてテーブルを出力します。サマリーには、フローに入ったユーザー数、完了したユーザー数、ドロップ率、収益が表示されます。テーブルには各ステップが1行で表示され、列は Step、Type、Reached、Completed、Drop rate、Revenue です。複数の画面を持つステップは、各画面につき1行が追加されます。オンボーディング画面の収益など、適用されない値は — と表示されます。
フローに入ったユーザーが該当期間に存在しない場合、テーブルにはそのバージョンの画面がゼロで表示されます。回答の各フィールドには --json を使用してください。
次のステップ
- コマンドリファレンス — すべての CLI トピック、グローバルフラグ、ページネーションフラグ。
- フローのバージョン履歴 — Flow & Paywall Builder でのバージョン管理。