Lệnh Flows
Flows là các paywall và onboarding bạn xây dựng trong Flow & Paywall Builder. CLI quản lý bản ghi flow, cấu hình builder, trạng thái xuất bản và lịch sử phiên bản. Cấu hình builder là một tài liệu JSON lớn do Flow & Paywall Builder tạo ra, và CLI không tự tạo ra tài liệu này. Để soạn thảo hoặc chỉnh sửa cấu hình từ terminal, hãy dùng flow-generator skill, công cụ này sẽ điều hướng các lệnh cho bạn. Trước khi xuất bản, flow-audit skill sẽ kiểm tra xem flow đã sẵn sàng cho môi trường production chưa. Các lệnh flows metrics đọc số liệu từ trang flow metrics và yêu cầu CLI phiên bản 0.15.0 trở lên. Các lệnh flows funnel đọc dữ liệu từ flow funnel và yêu cầu CLI phiên bản 0.19.0 trở lên. Các lệnh được liệt kê ở đây để tham khảo.
adapty flows list
Liệt kê tất cả các flow của một ứng dụng.
adapty flows list --app <app-id>
| Flag | Required | Description |
|---|---|---|
--app | Yes | App ID (UUID) |
Chấp nhận cờ phân trang.
adapty flows get
Lấy thông tin chi tiết của một flow cụ thể.
adapty flows get --app <app-id> <flow-id>
| Argument | Description |
|---|---|
flow-id | Flow ID (UUID) |
| Flag | Required | Description |
|---|---|---|
--app | Yes | App ID (UUID) |
Phản hồi chứa id, name, status, published_flow_version_id, và updated_at. published_flow_version_id là ID của phiên bản đang hoạt động, hoặc null khi flow chưa từng được xuất bản. Status là một trong các giá trị sau:
| Trạng thái | Ý nghĩa |
|---|---|
draft | Flow chưa được xuất bản lần nào |
published | Phiên bản hiện tại đang hoạt động |
dirty | Flow đã được xuất bản trước đó, và phiên bản hiện tại có thay đổi chưa được xuất bản. Người dùng vẫn thấy phiên bản đã xuất bản lần cuối |
publishing | Đang trong quá trình xuất bản |
publication_failed | Lần xuất bản gần nhất thất bại. Hãy sửa cấu hình và xuất bản lại |
archived | Flow đã được lưu trữ |
adapty flows create
Tạo một flow. Flow mới có tên và chưa có config. Để thêm config, dùng flows config update.
adapty flows create --app <app-id> --name "Onboarding"
| Flag | Bắt buộc | Mô tả |
|---|---|---|
--app | Có | App ID (UUID) |
--name | Có | Tên flow |
adapty flows update
Đổi tên một flow.
adapty flows update --app <app-id> <flow-id> --name "Onboarding v2"
| Argument | Description |
|---|---|
flow-id | Flow ID (UUID) |
| Flag | Required | Description |
|---|---|---|
--app | Yes | App ID (UUID) |
--name | Yes | Tên flow mới |
adapty flows publish
Xuất bản phiên bản hiện tại của một flow cho người dùng.
adapty flows publish --app <app-id> <flow-id>
| Đối số | Mô tả |
|---|---|
flow-id | ID của flow (UUID) |
| Cờ | Bắt buộc | Mô tả |
|---|---|---|
--app | Có | ID của ứng dụng (UUID) |
--yes, -y | Không | Xuất bản mà không cần xác nhận. Bắt buộc khi đầu ra được chuyển qua pipe hoặc dùng --json |
Vì việc xuất bản ảnh hưởng trực tiếp đến những gì người dùng thấy, lệnh này sẽ in tên flow và yêu cầu xác nhận. Bất kỳ câu trả lời nào khác y đều hủy lệnh với mã thoát 1. Khi dùng --json hoặc trong pipe, lệnh sẽ từ chối với mã thoát 2 thay vì chờ câu trả lời, vì vậy hãy truyền --yes trong các script và phiên agent.
Quá trình xuất bản là bất đồng bộ: phản hồi trả về status: publishing, và flow chưa được kích hoạt ngay. Hãy gọi flows get theo chu kỳ cho đến khi trạng thái chuyển thành published hoặc publication_failed. Nếu là publication_failed, hãy dùng flows config get để xem nguyên nhân.
Xuất bản sẽ thất bại với HTTP 400 khi flow chưa có config, khi config không thể xuất bản được, hoặc khi phiên bản hiện tại đã được kích hoạt. Để kiểm tra config trước khi xuất bản, hãy dùng flows config validate.
adapty flows config get
Đọc cấu hình builder của một flow.
adapty flows config get --app <app-id> <flow-id>
| Argument | Description |
|---|---|
flow-id | Flow ID (UUID) |
| Flag | Required | Description |
|---|---|---|
--app | Yes | App ID (UUID) |
Phản hồi chứa config, remote_configs, status, và updated_at. updated_at là timestamp tính bằng mili giây của lần thay đổi config gần nhất. Truyền giá trị này vào flows config update qua tham số --expected-updated-at để tránh ghi đè khi có chỉnh sửa đồng thời. Một flow chưa từng được ghi config sẽ trả về 404.
Sau khi thực hiện publication, phản hồi cũng chứa ba trường mô tả kết quả. Đọc các trường này khi flows get báo publication_failed:
| Field | Description |
|---|---|
publication_status | Trạng thái xuất bản của phiên bản flow này: transforming, transformed, uploading, uploaded, published, hoặc failed |
transform_error | Lỗi transform thô — có thể là payload JSON liệt kê các vấn đề hoặc một chuỗi tóm tắt |
publication_error | Thông báo dễ đọc cho một lần xuất bản thất bại |
adapty flows config update
Ghi lại cấu hình builder của một flow và các remote config của nó.
adapty flows config get --app <app-id> <flow-id> --json > flow.json
adapty flows config update --app <app-id> <flow-id> --file flow.json
| Đối số | Mô tả |
|---|---|
flow-id | ID của flow (UUID) |
| Cờ | Bắt buộc | Mô tả |
|---|---|---|
--app | Có | ID ứng dụng (UUID) |
--file | Thay thế cho --config, --config-file, và --remote-configs | Đường dẫn đến file JSON chứa config và remote_configs, hoặc - để đọc từ stdin. Đầu ra của flows config get --json dùng được ngay. Các key khác bị bỏ qua |
--config | Khi không dùng --file: một trong --config và --config-file | Cấu hình builder dưới dạng chuỗi JSON |
--config-file | Khi không dùng --file: một trong --config và --config-file | Đường dẫn đến file JSON chứa cấu hình builder, hoặc - để đọc từ stdin |
--remote-configs | Khi không dùng --file | Mảng JSON gồm các entry {locale, data}, trong đó data là remote config dưới dạng chuỗi. [] sẽ xóa toàn bộ remote config |
--expected-updated-at | Không | Giá trị updated_at từ lần flows config get trước đó. Nếu cấu hình thay đổi sau lần đọc đó, lệnh sẽ thất bại thay vì ghi đè lên thay đổi đó. Bỏ qua tham số này để ghi đè vô điều kiện |
Một lần ghi sẽ thay thế toàn bộ cấu hình và danh sách remote config. Để giữ lại các remote config, hãy gửi remote_configs từ lệnh flows config get --json. Nếu không dùng --file, lệnh cần cả cấu hình lẫn --remote-configs: nếu thiếu một trong hai, lệnh sẽ thoát với mã 2 và không gửi bất kỳ request nào. Cờ --file và --remote-configs bắt buộc cần CLI phiên bản 0.20.0 trở lên.
Để ghi cấu hình đầu tiên cho một flow mới, truyền vào danh sách remote config rỗng:
adapty flows config update --app <app-id> <flow-id> --config-file config.json --remote-configs '[]'
Việc ghi config sẽ lưu bản nháp và không xuất bản ngay. Trên một flow đã xuất bản, thao tác ghi sẽ tạo ra một phiên bản mới: trạng thái của flow sẽ chuyển thành dirty, và người dùng vẫn thấy phiên bản đã xuất bản cho đến khi bạn chạy flows publish.
adapty flows config validate
Kiểm tra xem một builder config có thể publish được hay không, mà không cần lưu.
adapty flows config validate --app <app-id> <flow-id> --config-file config.json
| Argument | Description |
|---|---|
flow-id | Flow ID (UUID) |
| Flag | Required | Description |
|---|---|---|
--app | Yes | App ID (UUID) |
--config | One of the two | Builder config dạng chuỗi JSON |
--config-file | One of the two | Đường dẫn đến file JSON chứa builder config, hoặc - để đọc từ stdin |
Phản hồi bao gồm valid và danh sách issues. Khi cấu hình không thể xuất bản, lệnh thoát với mã 1, giúp các script có thể dựa vào đó để kiểm soát luồng xử lý.
adapty flows config preview
Hiển thị file config cục bộ trên trình duyệt. Lệnh này không thực hiện lệnh gọi API và không nhận flag --app.
adapty flows config preview ./config.json --screen <screen-id> --device iphone-14 --orientation portrait
| Đối số | Mô tả |
|---|---|
config-file | Đường dẫn đến file JSON config của builder cục bộ |
| Flag | Mặc định | Mô tả |
|---|---|---|
--screen | Màn hình đầu tiên của flow | ID màn hình cần hiển thị |
--device | iphone-14 | Khung thiết bị để hiển thị |
--orientation | portrait | portrait hoặc landscape |
Trong terminal, lệnh sẽ mở bản xem trước trong trình duyệt của bạn. Khi dùng pipe hoặc với --json, lệnh sẽ in URL ra thay thế. URL chứa toàn bộ cấu hình nên khá dài: hãy pipe vào công cụ chụp ảnh màn hình thay vì in ra trực tiếp. Các cấu hình vượt quá khoảng 32 KB sẽ render chậm.
adapty flows media upload
Tải lên hình ảnh để sử dụng trong cấu hình flow.
adapty flows media upload --app <app-id> ./hero.png
| Argument | Description |
|---|---|
file | Path to the image file |
| Flag | Required | Description |
|---|---|---|
--app | Yes | App ID (UUID) |
Các định dạng được chấp nhận: PNG, JPEG, WebP và SVG. Phản hồi chứa id, name và url CDN của hình ảnh để tham chiếu từ cấu hình. Để tải lên video, hãy dùng flows media upload-video.
adapty flows media upload-video
Tải lên video để sử dụng trong cấu hình flow.
adapty flows media upload-video --app <app-id> ./intro.mp4
| Argument | Description |
|---|---|
file | Đường dẫn đến tệp video |
| Flag | Required | Description |
|---|---|---|
--app | Yes | App ID (UUID) |
Định dạng được chấp nhận: MP4 và WebM. Video tối đa 30 giây và tối đa 50 MB, chiều rộng và chiều cao mỗi chiều phải ít nhất 640 pixel. GIF không được hỗ trợ, và lệnh này không chuyển đổi ảnh động sang video.
Phản hồi chứa URL video (một HLS playlist), URL ảnh xem trước, cũng như width và height của video. Trong config, một phần tử video nhận các giá trị này qua videoUrl, previewUrl, width, và height.
adapty flows versions list
Liệt kê các phiên bản của một flow, mới nhất trước. Đây là các phiên bản trong lịch sử phiên bản trong Flow & Paywall Builder.
adapty flows versions list --app <app-id> <flow-id>
| Đối số | Mô tả |
|---|---|
flow-id | ID của flow (UUID) |
| Flag | Bắt buộc | Mô tả |
|---|---|---|
--app | Có | ID của app (UUID) |
--search | Không | Chỉ hiển thị các phiên bản có tiêu đề chứa đoạn văn bản này. Không phân biệt chữ hoa/thường, khớp một phần từ: friday tìm được Black Friday |
Mỗi dòng hiển thị tiêu đề, trạng thái, ngày và ID của một phiên bản. Tiêu đề là tên phiên bản, hoặc Version N nếu phiên bản chưa có tên. Trạng thái là một trong các giá trị sau:
| Trạng thái | Ý nghĩa |
|---|---|
draft | Phiên bản bạn đang chỉnh sửa. Một flow có một draft hoặc không có. Trong khi draft đang được xuất bản, dòng đó kết thúc bằng Publishing…, và sau khi xuất bản thất bại thì kết thúc bằng Publish failed |
live | Phiên bản người dùng của bạn đang thấy |
previous | Phiên bản cũ hơn. Nó đã từng là live trước đây, hoặc một phiên bản mới hơn đã thay thế nó trước khi được xuất bản |
Ngày của phiên bản live hoặc previous là ngày bắt đầu xuất bản. Với bản nháp và phiên bản previous chưa từng được xuất bản, đó là ngày phiên bản được tạo.
Với flow chưa từng được xuất bản, lệnh sẽ in ra History will appear after the first publish. và dòng bản nháp bên dưới. Lịch sử phiên bản trên dashboard không hiển thị dòng nào cho flow như vậy. Khi không có phiên bản nào khớp với --search, lệnh sẽ in ra No versions match the search.
Lệnh luôn liệt kê tất cả các phiên bản và không nhận flag phân trang.
Với --json, lệnh in ra {data, meta} từ Adapty không thay đổi, với các hàng nằm trong data. Mỗi hàng có các trường flow_version_id, version, name, title, state, is_current, publication_status, published_at, created_at, updated_at, và last_edited_by. updated_at là timestamp tính bằng mili giây của lần thay đổi nội dung cuối cùng của phiên bản: truyền giá trị updated_at của bản nháp vào flows versions restore dưới dạng --expected-updated-at. last_edited_by cho biết tên người dùng đã thay đổi phiên bản lần cuối, hoặc là null khi Adapty không xác định được người dùng.
adapty flows versions get
Đọc một phiên bản của flow. Việc đọc phiên bản không thay đổi gì cả: bản nháp và phiên bản live vẫn giữ nguyên.
Lệnh này in ra tiêu đề, ID, số thứ tự, trạng thái, ngày tạo của phiên bản, người dùng đã thay đổi nó lần cuối, và liên kết Test on device. Toàn bộ nội dung của phiên bản — cấu hình builder với mọi layout, Remote Config, và các paywall — nằm trong kết quả đầu ra của --json, và trong file của --output.
adapty flows versions get --app <app-id> <flow-id> <version-id> --output version.json
| Đối số | Mô tả |
|---|---|
flow-id | Flow ID (UUID) |
version-id | Version ID (UUID), từ flows versions list |
| Cờ | Bắt buộc | Mô tả |
|---|---|---|
--app | Có | App ID (UUID) |
--output | Không | Ghi toàn bộ nội dung của phiên bản vào file này dưới dạng JSON |
--yes, -y | Không | Thay thế file --output đã tồn tại mà không hỏi. Bắt buộc khi dùng --json hoặc trong pipe nếu file đã tồn tại |
Nếu CLI không thể ghi file --output, ví dụ vì thư mục chứa nó không tồn tại, lệnh sẽ in ra Could not write <path> (<errno>). và thoát với mã lỗi 1.
adapty flows versions preview
In ra link Test on device của một phiên bản. Mở link trên thiết bị kiểm thử để xem phiên bản đó trong ứng dụng Adapty trên di động. Bất kỳ phiên bản nào cũng dùng được: bản nháp, phiên bản đang live, hoặc phiên bản cũ hơn.
adapty flows versions preview --app <app-id> <flow-id> <version-id>
| Đối số | Mô tả |
|---|---|
flow-id | Flow ID (UUID) |
version-id | Version ID (UUID) |
| Flag | Bắt buộc | Mô tả |
|---|---|---|
--app | Có | App ID (UUID) |
adapty flows versions rename
Đổi tên một phiên bản. Bạn có thể đổi tên bản nháp, phiên bản đang live và các phiên bản trước đó.
adapty flows versions rename --app <app-id> <flow-id> <version-id> --name "Black Friday"
| Đối số | Mô tả |
|---|---|
flow-id | Flow ID (UUID) |
version-id | Version ID (UUID) |
| Flag | Bắt buộc | Mô tả |
|---|---|---|
--app | Có | App ID (UUID) |
--name | Có | Tên phiên bản mới. Truyền --name "" để xóa tên, khi đó phiên bản sẽ hiển thị lại là Version N. Tên chỉ gồm khoảng trắng cũng sẽ xóa tên |
Lệnh này in ra ID phiên bản và tiêu đề mới. Adapty tự động cắt bỏ khoảng trắng ở đầu và cuối tên. Hai phiên bản có thể có cùng tên. Việc đổi tên không thay đổi nội dung hay updated_at của phiên bản, do đó sẽ không xung đột với lần lưu draft sau.
adapty flows versions restore
Khôi phục một phiên bản thành bản nháp của flow tương ứng. Đây là Duplicate as draft trong lịch sử phiên bản. Phiên bản được khôi phục sẽ không đến tay người dùng cho đến khi bạn xuất bản nó.
Khôi phục sẽ thay thế bản nháp hiện tại. Để giữ lại bản nháp, hãy nhân bản nó thành một flow mới trước bằng lệnh flows duplicate.
adapty flows versions restore --app <app-id> <flow-id> <version-id>
| Đối số | Mô tả |
|---|---|
flow-id | Flow ID (UUID) |
version-id | Version ID (UUID) của phiên bản live hoặc previous |
| Cờ | Bắt buộc | Mô tả |
|---|---|---|
--app | Có | App ID (UUID) |
--expected-updated-at | Khi dùng --yes và flow có bản nháp | Giá trị updated_at của bản nháp, lấy từ flows versions list --json. Nếu bản nháp đã thay đổi sau lần đọc đó, lệnh sẽ thất bại thay vì ghi đè thay đổi |
--yes, -y | Không | Thay thế bản nháp mà không hỏi xác nhận. Bắt buộc khi dùng --json hoặc trong pipe nếu flow có bản nháp |
Lệnh đọc các phiên bản của flow trước tiên:
- Flow không có bản nháp: Lệnh không hỏi gì thêm. Adapty tạo một bản nháp mới với số phiên bản tiếp theo, không có tên, và toàn bộ nội dung của phiên bản đó. Phiên bản live và phiên bản bạn khôi phục vẫn giữ nguyên như cũ.
- Flow đã có bản nháp: Lệnh hỏi
Replace the draft '<draft>' (last change <time> by <user>) with '<version>'? To keep the draft, duplicate it to a new flow first., rồiApply? [y/N]. Nếu bạn trả lờiy, bản nháp giữ nguyên ID, số và tên, và nhận nội dung của phiên bản đó. Không có phiên bản nào được thêm vào. Bất kỳ câu trả lời nào khác sẽ thoát với mã lỗi 1 và không gửi gì cả.
Với --json, trong pipe, hoặc khi không có terminal, lệnh không thể hỏi. Khi flow có bản nháp, lệnh sẽ không gửi gì và thoát với code 6 trừ khi bạn truyền --yes. Thông báo của nó đặt câu hỏi và thêm To replace it, re-run with --yes --expected-updated-at <ms> (the draft's updated_at)., với updated_at của bản nháp thay cho <ms>. Với --yes, cũng cần truyền --expected-updated-at: nếu không có, lệnh thoát với code 6 và không gửi gì. Trong terminal mà không có --expected-updated-at, lệnh lấy updated_at của bản nháp mà nó hiển thị cho bạn trong câu hỏi.
Sau khi khôi phục, lệnh sẽ in ra Restored '<version>' as the draft '<draft>' (<draft-id>). Nothing is published.
Adapty từ chối khôi phục và không thay đổi gì trong các trường hợp sau. Lệnh sẽ in thông báo của Adapty, bổ sung hướng dẫn cho một số trường hợp, rồi thoát với mã 4:
| Thông báo | Cách xử lý |
|---|---|
This flow version is already the current draft. | Chọn một phiên bản khác. |
Flow version does not exist. | ID phiên bản không có trong danh sách các phiên bản của flow này. Lấy ID từ flows versions list. |
Flow version is already being published. | Chờ quá trình xuất bản hoàn tất, rồi khôi phục lại. |
This flow version uses deleted products: … | Chọn một phiên bản không sử dụng các sản phẩm đó. |
This flow configuration was already updated by … | Một thành viên trong nhóm đã thay đổi bản nháp sau khi bạn đọc nó. Liệt kê lại các phiên bản và thử lại. |
Flow is deleted. | Flow đã bị lưu trữ. Hãy khôi phục nó từ kho lưu trữ trong dashboard trước. |
adapty flows duplicate
Sao chép một flow, hoặc một trong các phiên bản của nó, thành một flow mới. Đây là Duplicate flow trong nút actions của flow ở thanh trên cùng của Flow & Paywall Builder (xem Sao chép flow), và Duplicate as new flow trong lịch sử phiên bản.
adapty flows duplicate --app <app-id> <flow-id> --version <version-id>
| Đối số | Mô tả |
|---|---|
flow-id | ID của flow (UUID) |
| Cờ | Bắt buộc | Mô tả |
|---|---|---|
--app | Có | ID ứng dụng (UUID) |
--version | Không | ID phiên bản (UUID) cần sao chép, lấy từ flows versions list. Bất kỳ phiên bản nào cũng được, kể cả bản nháp. Nếu không chỉ định, lệnh sẽ sao chép bản nháp, hoặc phiên bản đang chạy nếu flow không có bản nháp |
Lệnh in ra New flow '<name>' (<flow-id>), not published. Flow mới được đặt tên theo flow nguồn với hậu tố _copy ở cuối. Flow này chưa được xuất bản, và có một bản nháp với nội dung của phiên bản đó. Flow nguồn, bản nháp và lịch sử của nó vẫn giữ nguyên. Bạn có thể nhân đôi một flow trong khi nó đang được xuất bản.
Adapty từ chối sao chép một phiên bản sử dụng sản phẩm đã bị xóa, và từ chối sao chép một flow đã được lưu trữ. Các thông báo lỗi giống như với flows versions restore.
adapty flows metrics list
Hiển thị chỉ số tổng hợp của nhiều flow, mỗi dòng tương ứng một flow. Đây là dữ liệu từ bảng flow trên dashboard.
adapty flows metrics list --app <app-id> --ids <flow-id>,<flow-id>
| Flag | Bắt buộc | Mô tả |
|---|---|---|
--app | Có | App ID (UUID) |
--ids | Có | Flow ID (UUID). Phân tách bằng dấu phẩy hoặc lặp lại flag |
--csv | Không | In dạng CSV: mỗi hàng là một flow, bao gồm flow ID và 27 chỉ số. Không dùng được cùng với --json |
Mỗi dòng hiển thị ID flow kèm theo lượt xem, số lần mua, số lần dùng thử, và doanh thu. --json và --csv bao gồm đầy đủ 27 chỉ số của trang flow metrics, ví dụ như unique_profiles_views, net_revenue, và conversion_rate_purchases. Chỉ số nào không có dữ liệu sẽ là 0, không bao giờ là null. Với mỗi flow chưa được xuất bản lần nào, lệnh sẽ in <flow-id>: No data: the flow was never published. bên dưới bảng. --json thêm note: "never_published" vào hàng của flow đó, còn với --csv thì các ghi chú được xuất ra stderr để CSV luôn sạch.
Giá trị chỉ số của adapty flows
Liệt kê các khóa và giá trị bộ lọc của một flow: những gì flows metrics get --filter nhận vào.
adapty flows metrics values --app <app-id> <flow-id>
| Đối số | Mô tả |
|---|---|
flow-id | ID của flow (UUID) |
| Cờ | Bắt buộc | Mô tả |
|---|---|---|
--app | Có | ID ứng dụng (UUID) |
Mỗi dòng hiển thị một nhãn và, trong ngoặc đơn, giá trị cần truyền vào. Các giá trị được lồng nhau theo cách bộ lọc trên dashboard lồng nhau:
Country (country)
Americas (Americas)
United States (US)
Europe (Europe)
Germany (DE)
Store (store)
App Store (app_store)
Google Play (play_store)
Giá trị đầu tiên của mỗi nhóm là khóa bộ lọc, còn các giá trị trong cùng là những gì khóa đó nhận. Trong ví dụ trên, --filter country=US giữ lại Hoa Kỳ, và --filter store=play_store giữ lại Google Play.
adapty flows metrics get
Hiển thị chỉ số của một flow trong một khoảng thời gian, dưới dạng cây của trang chỉ số flow.
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
| Tham số | Mô tả |
|---|---|
flow-id | Flow ID (UUID) |
| Flag | Bắt buộc | Mô tả |
|---|---|---|
--app | Có | App ID (UUID) |
--based-on | Có | Cấp đầu tiên của cây phân chia theo tiêu chí gì: placement hoặc audience. Đây là chế độ xem theo placement và theo đối tượng của trang chỉ số flow |
--date-type | Có | Ngày nào áp dụng cho khoảng thời gian: purchase_date, hoặc profile_install_date để lọc theo ngày cài đặt |
--date-from | Không | Ngày đầu tiên của khoảng thời gian, bao gồm ngày đó (YYYY-MM-DD). Dùng cùng với --date-to |
--date-to | Không | Ngày cuối cùng của khoảng thời gian, bao gồm ngày đó (YYYY-MM-DD). Dùng cùng với --date-from |
--granularity | Không | Chia khoảng thời gian thành các điểm: day, week, month, quarter, hoặc year |
--filter | Không | Chỉ giữ lại dữ liệu có các giá trị của khóa lọc này. Có thể lặp lại. Xem Lọc chỉ số |
--timezone | Không | Múi giờ IANA cho các điểm trong khoảng thời gian, ví dụ Europe/Berlin. Nếu không có, Adapty sẽ dùng múi giờ của ứng dụng |
--depth | Không | Số cấp của cây được in dưới Total. Mặc định: 1 |
--csv | Không | In dạng CSV: một hàng cho mỗi nút của toàn bộ cây. Không thể dùng cùng với --json |
Đối với một flow chưa từng được xuất bản, lệnh sẽ in ghi chú No data: the flow was never published. phía trên các con số, và --json sẽ thêm note: "never_published". Với --csv, ghi chú được gửi ra stderr để CSV vẫn sạch.
Để xem doanh thu của một flow, chạy adapty analytics chart --app <app-id> --chart revenue --date-from <YYYY-MM-DD> --date-to <YYYY-MM-DD> --filter flow_id=<flow-id>. Xem Lệnh Analytics.
CLI thoát với mã 2 và không gửi yêu cầu nào khi thiếu --based-on hoặc --date-type, hoặc khi chỉ cung cấp một đầu của khoảng thời gian. Adapty xác thực các giá trị của --based-on, --date-type và --granularity: giá trị sai sẽ thoát với mã 4, và thông báo lỗi liệt kê các giá trị được chấp nhận.
Đọc kết quả đầu ra
Lệnh in ra một dòng Total, sau đó là cấp đầu tiên của cây bên dưới. Mỗi dòng hiển thị lượt xem, lượt mua, số lần dùng thử và doanh thu. Khi dùng --granularity, các điểm dữ liệu của khoảng thời gian sẽ hiển thị ngay bên dưới nút tương ứng:
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
Các cấp của cây tương ứng với các cấp trên dashboard: placement, đối tượng, A/B test, biến thể flow, màn hình và sản phẩm. Với --based-on audience, cấp placement bị bỏ qua. Để in thêm nhiều cấp hơn, truyền --depth, ví dụ --depth 3.
Để xem toàn bộ cây với tất cả 27 chỉ số, sử dụng một trong các flag sau:
--jsonin nguyên văn kết quả trả về từ server.--csvin một hàng cho mỗi nút, bao gồm cả các điểm period. Các cột gồmpath(tiêu đề từTotalxuống đến nút, phân cách bằng>),level,title, và sau đó là các chỉ số.
Lọc các chỉ số
Viết mỗi --filter theo dạng key=value, với các key và value mà flows metrics values liệt kê. Để giữ nhiều giá trị cùng lúc, hãy phân tách chúng bằng dấu phẩy hoặc lặp lại cờ với cùng key. Các filter với key khác nhau kết hợp với nhau, nghĩa là dữ liệu phải khớp với tất cả chúng:
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 gửi mỗi giá trị đúng như đã viết. Để đặt dấu phẩy trong một giá trị, hãy dùng \,. Giá trị rỗng cũng là một giá trị hợp lệ: attribution_channel= giữ lại dữ liệu mà không có kênh, và flows metrics values sẽ liệt kê giá trị đó là No Data.
adapty flows funnel values
Liệt kê các key và value của bộ lọc cho funnel của một flow: những gì flows funnel get --filter nhận vào.
adapty flows funnel values --app <app-id> <flow-id>
| Đối số | Mô tả |
|---|---|
flow-id | ID của flow (UUID) |
| Flag | Bắt buộc | Mô tả |
|---|---|---|
--app | Có | ID của app (UUID) |
Kết quả đầu ra có cùng định dạng với flows metrics values.
adapty flows funnel get
Hiển thị màn hình mà người dùng rời khỏi một flow: phễu của một phiên bản flow, từng bước và từng màn hình, giống như trên tab Funnel của flow.
adapty flows funnel get --app <app-id> <flow-id> --date-from 2026-09-01 --date-to 2026-10-21 --date-type purchase_date
| Đối số | Mô tả |
|---|---|
flow-id | ID của flow (UUID) |
| Cờ | Bắt buộc | Mô tả |
|---|---|---|
--app | Có | App ID (UUID) |
--date-from | Có | Ngày đầu tiên của kỳ, bao gồm cả ngày này (YYYY-MM-DD), theo múi giờ --timezone hoặc múi giờ của ứng dụng |
--date-to | Có | Ngày cuối cùng của kỳ, bao gồm cả ngày này (YYYY-MM-DD), theo múi giờ --timezone hoặc múi giờ của ứng dụng |
--date-type | Có | Ngày nào được áp dụng cho kỳ: purchase_date hoặc profile_install_date |
--flow-version-id | Không | ID phiên bản flow (UUID) cần đọc. Nếu không có, CLI sẽ đọc phiên bản đã xuất bản |
--filter | Không | Chỉ giữ lại người dùng có các giá trị này của khóa lọc, theo dạng key=value. Có thể lặp lại. Các khóa và giá trị lấy từ flows funnel values và hoạt động như trong Filter the metrics |
--timezone | Không | Múi giờ IANA của các ngày, ví dụ Europe/Berlin. Nếu không có, Adapty sẽ dùng múi giờ của ứng dụng |
--csv | Không | In file CSV mà dashboard tải xuống, với hàng tổng cộng ở đầu. Không thể dùng cùng với --json |
Lệnh này in ra phiên bản flow, khoảng thời gian, một dòng tóm tắt và một bảng. Phần tóm tắt hiển thị số người dùng đã vào flow, số người đã hoàn thành, tỷ lệ thoát và doanh thu. Bảng có một hàng cho mỗi bước, với các cột Step, Type, Reached, Completed, Drop rate và Revenue. Một bước có nhiều hơn một màn hình cũng có thêm một hàng cho mỗi màn hình của nó. Giá trị không áp dụng, chẳng hạn như doanh thu của màn hình onboarding, được hiển thị là —.
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.
Tiếp theo
- Tham chiếu lệnh — tất cả các chủ đề CLI, các cờ toàn cục và cờ phân trang.
- Lịch sử phiên bản flow — các phiên bản tương tự trong Flow & Paywall Builder.