@thinkingai/ae-cli 6.0.31 → 6.0.33
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -2
- package/README.zh.md +3 -2
- package/dist/{auth-MEJ642P4.js → auth-ENM3FE6L.js} +3 -2
- package/dist/{auth-7H3HAAJ3.js → auth-UPGUOKTW.js} +13 -6
- package/dist/{capability-SEH3JWLN.js → capability-AJC5CBRT.js} +50 -18
- package/dist/{capability-SQ2IWKP3.js → capability-TQ5KU5Q6.js} +50 -18
- package/dist/chunk-24BAVOX3.js +51 -0
- package/dist/{chunk-MDJGDI6K.js → chunk-3KI3RRXX.js} +5 -5
- package/dist/{chunk-PKRD2IEM.js → chunk-3P3562ZX.js} +9 -7
- package/dist/{chunk-R77JT7XD.js → chunk-4Q5TNP4Q.js} +4 -4
- package/dist/{chunk-TKQJQXWT.js → chunk-6CHYBI64.js} +7 -4
- package/dist/{chunk-6LEYLOV3.js → chunk-CPVTECJ3.js} +9 -7
- package/dist/{chunk-KCA6BA5D.js → chunk-DB4Q3ANU.js} +5 -3
- package/dist/{chunk-2NDGFQHW.js → chunk-E7UXXHO3.js} +11 -3
- package/dist/{chunk-I4A62X3N.js → chunk-HQ2A7ITL.js} +23 -14
- package/dist/chunk-IMMGMU54.js +674 -0
- package/dist/{chunk-AJTH7LT3.js → chunk-IR4ZLVPW.js} +4 -2
- package/dist/{chunk-N2QORU5D.js → chunk-ISY6HMHM.js} +7 -4
- package/dist/{chunk-KGJQCYVC.js → chunk-LCXU3AAT.js} +4 -2
- package/dist/chunk-LYVNONC4.js +86 -0
- package/dist/{chunk-DYOS6YY7.js → chunk-RGXCNC4N.js} +23 -14
- package/dist/{chunk-YCLVYFK7.js → chunk-V6FR6WTW.js} +45 -87
- package/dist/chunk-VTWMIC5L.js +27 -0
- package/dist/{cli-token-TVQRSE46.js → cli-token-4SBMXAUK.js} +6 -3
- package/dist/{client-2643Z5AG.js → client-PP5FETMW.js} +4 -3
- package/dist/community-report-client-KK2QBANO.js +145 -0
- package/dist/{config-7UZWDE74.js → config-RCCGHHYA.js} +6 -3
- package/dist/index.js +541 -234
- package/dist/{metadata-W6JFFMBA.js → metadata-3M5F2AED.js} +15 -14
- package/dist/{metadata-X62TKIVK.js → metadata-W2MEOI4Z.js} +15 -14
- package/dist/{model-T3KZJWLW.js → model-OYQLXCQY.js} +3 -2
- package/dist/{raw-CN542NGT.js → raw-TPB7KSZO.js} +6 -4
- package/dist/{sync-ERNHDPB5.js → sync-EFJKFZK2.js} +6 -3
- package/dist/{te-agent-FCCWUDTJ.js → te-agent-K2OWMZXT.js} +3 -2
- package/dist/{te-analysis-NJGNWZFC.js → te-analysis-I73ZS4NK.js} +2196 -120
- package/dist/{te-analysis-YGV5V5EX.js → te-analysis-Q7AZCDU4.js} +2196 -120
- package/dist/te-common-ST3QPSXJ.js +61 -0
- package/dist/te-common-WSLIKKPC.js +61 -0
- package/dist/te-community-WXGB6IOX.js +1659 -0
- package/dist/te-community-X2AHXGCA.js +1659 -0
- package/dist/{te-dataops-ZNJBQ6VT.js → te-dataops-MJV54MNY.js} +10 -8
- package/dist/{te-dataops-F36T656A.js → te-dataops-OA7I6HBG.js} +10 -8
- package/dist/te-engage-GJRVQMK3.js +3895 -0
- package/dist/te-engage-JIXX3WBI.js +3895 -0
- package/dist/{te-kb-NT33UHAE.js → te-kb-CIZXRWMO.js} +105 -23
- package/dist/{te-meta-VKWNAWO4.js → te-meta-Q4L6EE3Q.js} +8 -240
- package/dist/{te-meta-MAAUHFQO.js → te-meta-VHCN4Q62.js} +8 -240
- package/dist/{te-team-OKCOX7OE.js → te-team-PDKKW7Q5.js} +7 -6
- package/dist/tracking/i18n/resources/cli/en.json +4 -3
- package/dist/tracking/i18n/resources/cli/ja.json +4 -3
- package/dist/tracking/i18n/resources/cli/ko.json +4 -3
- package/dist/tracking/i18n/resources/cli/zh.json +4 -3
- package/package.json +6 -2
- package/skills/ae-agent/SKILL.md +2 -1
- package/skills/ae-analysis/SKILL.md +21 -7
- package/skills/ae-analysis/references/adhoc_export.md +5 -6
- package/skills/ae-analysis/references/adhoc_run.md +7 -9
- package/skills/ae-analysis/references/ai_models.md +17 -1
- package/skills/ae-analysis/references/alert_create.md +25 -0
- package/skills/ae-analysis/references/alert_definition_schema_get.md +24 -0
- package/skills/ae-analysis/references/alert_delete.md +26 -0
- package/skills/ae-analysis/references/alert_detail_list.md +27 -0
- package/skills/ae-analysis/references/alert_get.md +25 -0
- package/skills/ae-analysis/references/alert_job_list.md +24 -0
- package/skills/ae-analysis/references/alert_list.md +27 -0
- package/skills/ae-analysis/references/alert_notice_config_list.md +24 -0
- package/skills/ae-analysis/references/alert_start.md +25 -0
- package/skills/ae-analysis/references/alert_stop.md +25 -0
- package/skills/ae-analysis/references/alert_update.md +26 -0
- package/skills/ae-analysis/references/analysis_data_retrieval.md +11 -11
- package/skills/ae-analysis/references/analysis_drilldown_contract.md +93 -0
- package/skills/ae-analysis/references/analysis_gateway_assets.md +9 -8
- package/skills/ae-analysis/references/asset_url_get.md +4 -3
- package/skills/ae-analysis/references/bi_panel_create.md +3 -3
- package/skills/ae-analysis/references/bi_panel_page_data_export.md +2 -2
- package/skills/ae-analysis/references/bi_panel_page_data_run.md +1 -1
- package/skills/ae-analysis/references/check_delete.md +27 -0
- package/skills/ae-analysis/references/check_export.md +27 -0
- package/skills/ae-analysis/references/check_get.md +27 -0
- package/skills/ae-analysis/references/check_list.md +24 -0
- package/skills/ae-analysis/references/check_retry.md +27 -0
- package/skills/ae-analysis/references/check_run.md +25 -0
- package/skills/ae-analysis/references/command_index.md +114 -46
- package/skills/ae-analysis/references/create_entity.md +2 -2
- package/skills/ae-analysis/references/dashboard_create.md +3 -3
- package/skills/ae-analysis/references/dashboard_daily_report_send.md +1 -0
- package/skills/ae-analysis/references/dashboard_daily_report_update.md +2 -0
- package/skills/ae-analysis/references/dashboard_report_data_export.md +4 -4
- package/skills/ae-analysis/references/dashboard_report_data_run.md +4 -4
- package/skills/ae-analysis/references/drilldown_entities_export.md +26 -0
- package/skills/ae-analysis/references/drilldown_entities_run.md +33 -0
- package/skills/ae-analysis/references/drilldown_events_export.md +21 -0
- package/skills/ae-analysis/references/drilldown_events_run.md +23 -0
- package/skills/ae-analysis/references/drilldown_user_events_export.md +6 -3
- package/skills/ae-analysis/references/drilldown_user_events_run.md +6 -6
- package/skills/ae-analysis/references/entity_detail_export.md +2 -0
- package/skills/ae-analysis/references/entity_detail_run.md +8 -1
- package/skills/ae-analysis/references/event_blacklist_add.md +25 -0
- package/skills/ae-analysis/references/event_blacklist_list.md +24 -0
- package/skills/ae-analysis/references/event_blacklist_update.md +26 -0
- package/skills/ae-analysis/references/event_detail_export.md +2 -0
- package/skills/ae-analysis/references/event_detail_run.md +2 -0
- package/skills/ae-analysis/references/event_list.md +10 -2
- package/skills/ae-analysis/references/ingest_error_list.md +27 -0
- package/skills/ae-analysis/references/ingest_summary.md +26 -0
- package/skills/ae-analysis/references/list_entities.md +1 -1
- package/skills/ae-analysis/references/live_data_export.md +27 -0
- package/skills/ae-analysis/references/live_data_list.md +27 -0
- package/skills/ae-analysis/references/metric_create.md +13 -4
- package/skills/ae-analysis/references/metric_delete.md +7 -0
- package/skills/ae-analysis/references/metric_get.md +6 -0
- package/skills/ae-analysis/references/metric_list.md +16 -3
- package/skills/ae-analysis/references/metric_update.md +12 -1
- package/skills/ae-analysis/references/plan_change_log_export.md +27 -0
- package/skills/ae-analysis/references/plan_change_log_list.md +24 -0
- package/skills/ae-analysis/references/plan_delete_items.md +30 -0
- package/skills/ae-analysis/references/plan_export.md +26 -0
- package/skills/ae-analysis/references/plan_generate.md +27 -0
- package/skills/ae-analysis/references/plan_get.md +24 -0
- package/skills/ae-analysis/references/plan_import_excel.md +26 -0
- package/skills/ae-analysis/references/plan_save_items.md +27 -0
- package/skills/ae-analysis/references/plan_sync_from_meta.md +24 -0
- package/skills/ae-analysis/references/project_access_detail_get.md +23 -0
- package/skills/ae-analysis/references/project_data_power_delete.md +26 -0
- package/skills/ae-analysis/references/project_data_power_get.md +24 -0
- package/skills/ae-analysis/references/project_data_power_list.md +23 -0
- package/skills/ae-analysis/references/project_data_power_upsert.md +24 -0
- package/skills/ae-analysis/references/project_entity_create.md +27 -0
- package/skills/ae-analysis/references/project_entity_delete.md +25 -0
- package/skills/ae-analysis/references/project_entity_event_list.md +24 -0
- package/skills/ae-analysis/references/project_entity_get.md +24 -0
- package/skills/ae-analysis/references/project_entity_list.md +28 -0
- package/skills/ae-analysis/references/project_entity_update.md +28 -0
- package/skills/ae-analysis/references/project_function_list.md +24 -0
- package/skills/ae-analysis/references/project_info_get.md +23 -0
- package/skills/ae-analysis/references/project_info_list.md +26 -0
- package/skills/ae-analysis/references/project_info_update.md +25 -0
- package/skills/ae-analysis/references/project_mark_time_create.md +27 -0
- package/skills/ae-analysis/references/project_mark_time_delete.md +25 -0
- package/skills/ae-analysis/references/project_mark_time_list.md +28 -0
- package/skills/ae-analysis/references/project_mark_time_update.md +28 -0
- package/skills/ae-analysis/references/project_member_add.md +25 -0
- package/skills/ae-analysis/references/project_member_batch_update.md +24 -0
- package/skills/ae-analysis/references/project_member_candidate_list.md +25 -0
- package/skills/ae-analysis/references/project_member_handover_export.md +27 -0
- package/skills/ae-analysis/references/project_member_handover_run.md +24 -0
- package/skills/ae-analysis/references/project_member_import.md +25 -0
- package/skills/ae-analysis/references/project_member_list.md +23 -0
- package/skills/ae-analysis/references/project_member_receiver_list.md +23 -0
- package/skills/ae-analysis/references/project_member_remove.md +26 -0
- package/skills/ae-analysis/references/project_member_update.md +25 -0
- package/skills/ae-analysis/references/project_owner_update.md +27 -0
- package/skills/ae-analysis/references/project_permission_binding_list.md +24 -0
- package/skills/ae-analysis/references/project_receive_status_update.md +25 -0
- package/skills/ae-analysis/references/project_role_delete.md +26 -0
- package/skills/ae-analysis/references/project_role_function_list.md +27 -0
- package/skills/ae-analysis/references/project_role_get.md +24 -0
- package/skills/ae-analysis/references/project_role_list.md +25 -0
- package/skills/ae-analysis/references/project_role_upsert.md +24 -0
- package/skills/ae-analysis/references/project_role_user_list.md +24 -0
- package/skills/ae-analysis/references/project_timezone_get.md +23 -0
- package/skills/ae-analysis/references/project_timezone_overview.md +23 -0
- package/skills/ae-analysis/references/project_timezone_update.md +25 -0
- package/skills/ae-analysis/references/project_user_id_items_update.md +24 -0
- package/skills/ae-analysis/references/property_list.md +21 -6
- package/skills/ae-analysis/references/public_link_create.md +1 -1
- package/skills/ae-analysis/references/query_create_result_cluster.md +15 -32
- package/skills/ae-analysis/references/report_create.md +1 -1
- package/skills/ae-analysis/references/report_data_export.md +5 -3
- package/skills/ae-analysis/references/report_data_run.md +13 -3
- package/skills/ae-analysis/references/report_get.md +2 -0
- package/skills/ae-analysis/references/report_update.md +1 -1
- package/skills/ae-analysis/references/sdk_sample_generate.md +24 -0
- package/skills/ae-analysis/references/user_cluster_create.md +5 -1
- package/skills/ae-analysis/references/user_cluster_create_id.md +2 -0
- package/skills/ae-analysis/references/user_cluster_get.md +4 -0
- package/skills/ae-analysis/references/user_cluster_refresh.md +4 -2
- package/skills/ae-analysis/references/user_cluster_update.md +5 -1
- package/skills/ae-analysis/references/user_cluster_update_id.md +2 -0
- package/skills/ae-analysis/references/user_tag_create.md +5 -1
- package/skills/ae-analysis/references/user_tag_create_id.md +2 -0
- package/skills/ae-analysis/references/user_tag_get.md +4 -0
- package/skills/ae-analysis/references/user_tag_refresh.md +4 -2
- package/skills/ae-analysis/references/user_tag_update.md +5 -1
- package/skills/ae-analysis/references/user_tag_update_id.md +2 -0
- package/skills/ae-analysis/references/virtual_event_create.md +22 -3
- package/skills/ae-analysis/references/virtual_property_create.md +23 -2
- package/skills/ae-analysis-global/SKILL.md +2 -0
- package/skills/ae-capability/SKILL.md +7 -5
- package/skills/ae-community/SKILL.md +72 -8
- package/skills/ae-community/references/community-chat-analysis.md +341 -0
- package/skills/ae-community/references/community-data-report.md +301 -0
- package/skills/ae-dataops/SKILL.md +2 -1
- package/skills/ae-engage/SKILL.md +204 -8
- package/skills/ae-engage/references/activity-activity-type.md +42 -0
- package/skills/ae-engage/references/activity-activity.md +70 -0
- package/skills/ae-engage/references/activity-approval.md +53 -0
- package/skills/ae-engage/references/activity-task.md +87 -0
- package/skills/ae-engage/references/activity-topic.md +98 -0
- package/skills/ae-engage/references/approval-approver-delete.md +26 -0
- package/skills/ae-engage/references/channel-test-send.md +37 -0
- package/skills/ae-engage/references/channel-touch-limits-batch-update.md +28 -0
- package/skills/ae-engage/references/channel-touch-limits-save.md +37 -0
- package/skills/ae-engage/references/channel-touch-limits-toggle.md +28 -0
- package/skills/ae-engage/references/channel-update-config.md +36 -0
- package/skills/ae-engage/references/client-param.md +58 -0
- package/skills/ae-engage/references/common-metric.md +75 -0
- package/skills/ae-engage/references/config-table.md +92 -0
- package/skills/ae-engage/references/engage-scene-config-item.md +69 -0
- package/skills/ae-engage/references/operation-log-query.md +1 -1
- package/skills/ae-engage/references/preset-event.md +42 -0
- package/skills/ae-engage/references/push-language.md +39 -0
- package/skills/ae-engage/references/scene-config-channel.md +58 -0
- package/skills/ae-engage/references/scene-config-group.md +62 -0
- package/skills/ae-engage/references/scene-config-item.md +68 -0
- package/skills/ae-engage/references/scene-config-metric.md +79 -0
- package/skills/ae-engage/references/scene-config-param.md +72 -0
- package/skills/ae-engage/references/scene-preset-metric.md +45 -0
- package/skills/ae-engage/references/scene-strategy.md +47 -0
- package/skills/ae-engage/references/scene-template.md +71 -0
- package/skills/ae-engage/references/{ops-delete.md → task-delete.md} +3 -3
- package/skills/ae-engage/references/whitelist.md +72 -0
- package/skills/ae-engage/references/workbench-workbench.md +48 -0
- package/skills/ae-generate-tracking-code/SKILL.md +4 -4
- package/skills/ae-generate-tracking-plan/SKILL.md +140 -16
- package/skills/ae-generate-tracking-plan/references/business-dimension-mapping.md +98 -33
- package/skills/ae-generate-tracking-plan/references/te-api.md +1 -1
- package/skills/ae-generate-tracking-plan/references/xlsx-schema.md +16 -14
- package/skills/ae-kb/SKILL.md +36 -9
- package/skills/ae-metadata/SKILL.md +3 -2
- package/skills/ae-metadata/references/metadata_event_get.md +4 -4
- package/skills/ae-metadata/references/metadata_property_dimension_table_bind_existing.md +1 -1
- package/skills/ae-metadata/references/metadata_property_get.md +4 -4
- package/skills/ae-team/SKILL.md +2 -1
- package/dist/chunk-NOO24N7W.js +0 -11
- package/dist/chunk-TNW2CI4W.js +0 -129
- package/dist/te-common-5NJLF3XG.js +0 -130
- package/dist/te-common-7VTJZPII.js +0 -130
- package/dist/te-community-PEZ2VEF7.js +0 -687
- package/dist/te-community-TSKJ652U.js +0 -687
- package/dist/te-engage-BUWVSSSK.js +0 -1912
- package/dist/te-engage-EPE3QKDE.js +0 -1912
- package/skills/ae-analysis/references/create_metric.md +0 -58
- package/skills/ae-analysis/references/create_virtual_event.md +0 -60
- package/skills/ae-analysis/references/create_virtual_property.md +0 -69
- package/skills/ae-analysis/references/delete_metric.md +0 -32
- package/skills/ae-analysis/references/drilldown_users_export.md +0 -17
- package/skills/ae-analysis/references/drilldown_users_run.md +0 -61
- package/skills/ae-analysis/references/get_metric.md +0 -38
- package/skills/ae-analysis/references/get_resource_url.md +0 -33
- package/skills/ae-analysis/references/list_events.md +0 -46
- package/skills/ae-analysis/references/list_metrics.md +0 -52
- package/skills/ae-analysis/references/list_properties.md +0 -47
- package/skills/ae-analysis/references/update_metric.md +0 -58
- package/dist/{chunk-HL2AJQ4Q.js → chunk-PTE56QPL.js} +3 -3
|
@@ -25,7 +25,7 @@ ae-cli analysis_meta +create_entity --dry-run
|
|
|
25
25
|
|
|
26
26
|
## Decision Rules
|
|
27
27
|
- `--table_type` must be `0` (event property) or `1` (user property); no other values are accepted.
|
|
28
|
-
- Before using `--column_name`, call `
|
|
28
|
+
- Before using `--column_name`, call `analysis-meta property list` to verify it exists. If the same column name appears in **both** event properties and user properties, **stop and ask the user which table type to use** — do not guess `--table_type`. Ask every time this condition is met; never carry over the answer from a previous request.
|
|
29
29
|
- For the first run, pass only the required parameters and confirm before adding others.
|
|
30
30
|
- This is an ordinary `write` operation and does not require CLI confirmation.
|
|
31
31
|
|
|
@@ -36,4 +36,4 @@ ae-cli analysis_meta +create_entity --dry-run
|
|
|
36
36
|
|
|
37
37
|
## Recommended Chaining
|
|
38
38
|
- `analysis_meta +list_entities` → `+create_entity`
|
|
39
|
-
- `
|
|
39
|
+
- `analysis-meta property list` → `+create_entity`
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
# analysis dashboard create
|
|
2
2
|
|
|
3
|
-
Use when the user explicitly wants to create
|
|
3
|
+
Use only when the user explicitly wants to create the product's analysis board (`看板`) in personal space, a project space, or a folder.
|
|
4
4
|
|
|
5
|
-
Do not use to copy an existing
|
|
5
|
+
Do not use for a BI dashboard (`仪表盘`); use `analysis bi-panel create` instead. Do not use to copy an existing analysis board; use `dashboard copy` for copy workflows.
|
|
6
6
|
|
|
7
7
|
Command:
|
|
8
8
|
|
|
@@ -12,4 +12,4 @@ ae-cli analysis dashboard create --project-id <project_id> --dashboard-name <nam
|
|
|
12
12
|
|
|
13
13
|
Input sends `project_id`, `dashboard_name`, and optional `space_id`, `folder_id`, `initial_report_id`, `payload`.
|
|
14
14
|
|
|
15
|
-
Output is the gateway envelope. `data` contains the created
|
|
15
|
+
Output is the gateway envelope. `data` contains the created analysis-board identity or backend create result.
|
|
@@ -17,6 +17,7 @@ Behavior:
|
|
|
17
17
|
- If no daily report config flags and no `--payload` are provided, the gateway uses the dashboard's saved daily report config.
|
|
18
18
|
- If the dashboard has no saved daily report config, the command fails with a stable business error instead of creating a misleading task.
|
|
19
19
|
- If any config flag or `--payload` is provided, the request config is used for this immediate send. Provide at least one valid channel, for example `--enable-dd true --dd-url '["https://..."]'`, or email fields such as `--enable-email true --email-login-users user@example.com`.
|
|
20
|
+
- For an explicit Feishu send, use `--enable-feishu true --feishu-info '{"app_id":"cli_xxx","app_secret":"secret_xxx","webhook":["https://open.feishu.cn/open-apis/bot/v2/hook/..."]}'`. All three fields are required because the backend obtains a tenant access token and uploads the dashboard image before calling the group-bot webhook. Treat `app_secret` as sensitive input. If the dashboard already has a complete saved Feishu config, omit all config flags to reuse it.
|
|
20
21
|
- Use `dashboard-daily-report update` to save or change scheduled daily report config.
|
|
21
22
|
|
|
22
23
|
Output is the gateway envelope. `data` contains the immediate send result.
|
|
@@ -14,4 +14,6 @@ Input sends `project_id`, `dashboard_id`, and optional daily report fields or `p
|
|
|
14
14
|
|
|
15
15
|
When `--payload` is absent, the command sends safe defaults expected by the gateway: `need_csv=false`, empty `host_url`, all channel switches false, `send_date=1,2,3,4,5,6,7`, `send_time=09:00`, `lang=zh-CN`, `screen_type=normal`, `zone_offset=0`, and `enable_send=false`. When `--payload` is present, payload values remain authoritative; pass top-level flags only for fields you intentionally want to override.
|
|
16
16
|
|
|
17
|
+
When enabling Feishu, pass `--enable-feishu true --feishu-info '{"app_id":"cli_xxx","app_secret":"secret_xxx","webhook":["https://open.feishu.cn/open-apis/bot/v2/hook/..."]}'`. All three fields are required because the backend uploads the dashboard image before calling the group-bot webhook. Treat `app_secret` as sensitive input.
|
|
18
|
+
|
|
17
19
|
Output is the gateway envelope. `data` contains the daily report configuration update result.
|
|
@@ -9,10 +9,10 @@ Do not use this command for bounded inline previews; use `dashboard-report-data
|
|
|
9
9
|
Command:
|
|
10
10
|
|
|
11
11
|
```bash
|
|
12
|
-
ae-cli analysis dashboard-report-data export --project-id <project_id> --dashboard-id <dashboard_id> [--report-ids '[1,2]'] [--filters '{...}'] [--start-time <time>] [--end-time <time>] [--artifact-format jsonl]
|
|
12
|
+
ae-cli analysis dashboard-report-data export --project-id <project_id> --dashboard-id <dashboard_id> [--report-ids '[1,2]'] [--filters '{...}'] [--start-time <time>] [--end-time <time>] [--zone-offset <offset>] [--artifact-format jsonl]
|
|
13
13
|
```
|
|
14
14
|
|
|
15
|
-
Input sends `project_id`, `dashboard_id`, and optional `report_ids`, `filters`, `start_time`, `end_time`, `use_cache`, `request_id`, `timeout_seconds`, `format`. Use CLI flag `--artifact-format` for the gateway `format` input; `--format` is the CLI output formatter. Async export has no inline row limit. Runtime defaults to and is capped at 21600 seconds (6 hours); cancel earlier with `analysis query cancel --run-id <run_id>`. The routing rule lives in [`analysis_data_retrieval.md`](analysis_data_retrieval.md).
|
|
15
|
+
Input sends `project_id`, `dashboard_id`, and optional `report_ids`, `filters`, `start_time`, `end_time`, `zone_offset`, `use_cache`, `request_id`, `timeout_seconds`, `format`. When `--zone-offset` is specified, that timezone is used for every selected non-SQL report. When omitted, the current user's `currentTimezone` is used when available, otherwise the project default. Fixed UTC offsets are `-12` through `14`; `99` is local-time mode and is not UTC+99. Use CLI flag `--artifact-format` for the gateway `format` input; `--format` is the CLI output formatter. Async export has no inline row limit. Runtime defaults to and is capped at 21600 seconds (6 hours); cancel earlier with `analysis query cancel --run-id <run_id>`. The routing rule lives in [`analysis_data_retrieval.md`](analysis_data_retrieval.md).
|
|
16
16
|
|
|
17
17
|
`--filters` uses the same AI-facing filter model as report data. The gateway resolves fields and compiles it to the dashboard backend filter. Do not pass a dashboard UI control dump or raw QP filter. Minimal shape:
|
|
18
18
|
|
|
@@ -22,11 +22,11 @@ Input sends `project_id`, `dashboard_id`, and optional `report_ids`, `filters`,
|
|
|
22
22
|
|
|
23
23
|
Dashboard `filters`, `start_time`, and `end_time` do not apply to SQL reports. Export still completes with SQL report data; the JSONL result object includes `warnings[]` with `OVERRIDE_IGNORED_FOR_MODEL`, affected SQL `report_ids`, and `ignored_fields`. Query SQL reports directly with report-data `--sql-params` when SQL conditions must change.
|
|
24
24
|
|
|
25
|
-
Output is the gateway envelope. `data` contains an async export descriptor with `run_id`, `artifact_id`,
|
|
25
|
+
Output is the gateway envelope. `data` contains an async export descriptor with `run_id`, `artifact_id`, `effective_zone_offset` (the timezone actually selected for the export), status fields, and expiration fields. Exports do not create `query_context_id`. It does not expose inspect/download API paths; use the CLI commands below.
|
|
26
26
|
|
|
27
27
|
An empty artifact is successful and means the requested time range has no data. The run reaches `FAILED` only when every returned dashboard report entry contains an explicit execution error. Mixed dashboard exports retain successful data and explicit per-report failure entries.
|
|
28
28
|
|
|
29
|
-
|
|
29
|
+
Never use the export response or downloaded rows as a drilldown/result-cluster source. Run a bounded synchronous dashboard report preview containing the desired cell first.
|
|
30
30
|
|
|
31
31
|
Follow-up workflow:
|
|
32
32
|
|
|
@@ -9,10 +9,10 @@ Do not use this command for full, unknown-size, larger than 1000-row, or long-ru
|
|
|
9
9
|
Command:
|
|
10
10
|
|
|
11
11
|
```bash
|
|
12
|
-
ae-cli analysis dashboard-report-data run --project-id <project_id> --dashboard-id <dashboard_id> [--report-ids '[1,2]'] [--filters '{...}'] [--start-time <time>] [--end-time <time>] [--limit 100] [--timeout-seconds 180]
|
|
12
|
+
ae-cli analysis dashboard-report-data run --project-id <project_id> --dashboard-id <dashboard_id> [--report-ids '[1,2]'] [--filters '{...}'] [--start-time <time>] [--end-time <time>] [--zone-offset <offset>] [--limit 100] [--timeout-seconds 180]
|
|
13
13
|
```
|
|
14
14
|
|
|
15
|
-
Input sends `project_id`, `dashboard_id`, and optional `report_ids`, `filters`, `start_time`, `end_time`, `use_cache`, `request_id`, `timeout_seconds`, `limit`. Control defaults: `--limit` default 100 / max 1000, `--timeout-seconds` default and max 180. An explicitly supplied lower timeout still wins. The routing rule lives in [`analysis_data_retrieval.md`](analysis_data_retrieval.md).
|
|
15
|
+
Input sends `project_id`, `dashboard_id`, and optional `report_ids`, `filters`, `start_time`, `end_time`, `zone_offset`, `use_cache`, `request_id`, `timeout_seconds`, `limit`. When `--zone-offset` is specified, that timezone is used for every selected non-SQL report. When omitted, the current user's `currentTimezone` is used when available, otherwise the project default. Fixed UTC offsets are `-12` through `14`; `99` is local-time mode and is not UTC+99. Control defaults: `--limit` default 100 / max 1000, `--timeout-seconds` default and max 180. An explicitly supplied lower timeout still wins. The routing rule lives in [`analysis_data_retrieval.md`](analysis_data_retrieval.md).
|
|
16
16
|
|
|
17
17
|
`--filters` uses the same AI-facing filter model as report data. The gateway resolves fields and compiles it to the dashboard backend filter. Do not pass a dashboard UI control dump or raw QP filter. Minimal shape:
|
|
18
18
|
|
|
@@ -22,8 +22,8 @@ Input sends `project_id`, `dashboard_id`, and optional `report_ids`, `filters`,
|
|
|
22
22
|
|
|
23
23
|
Dashboard `filters`, `start_time`, and `end_time` do not apply to SQL reports. The query still succeeds and returns those SQL report results. Inspect `data.warnings[]`; `OVERRIDE_IGNORED_FOR_MODEL` contains the affected SQL `report_ids` and `ignored_fields`. To change SQL conditions, query the SQL report directly with `analysis report-data run` and saved `definition.params` through `--sql-params`.
|
|
24
24
|
|
|
25
|
-
Output is the gateway envelope. `data` contains bounded inline report data, optional structured `warnings`, plus `query_context_id
|
|
25
|
+
Output is the gateway envelope. `data.effective_zone_offset` is the timezone actually used by the query, and each report source repeats it as `sources[].effective_zone_offset`. `data` also contains bounded inline report data, optional structured `warnings`, plus `query_context_id` and per-report `sources[].drilldown` options when a returned report exposes follow-up actions. Unsupported report models have empty actions.
|
|
26
26
|
|
|
27
27
|
An empty dashboard batch or report result with no rows is a successful query: it means the requested time range has no data. The command fails only when every returned report entry contains an explicit execution error. Mixed dashboard batches keep successful data and return `meta.partial`, counts, and per-report `meta.failures`.
|
|
28
28
|
|
|
29
|
-
|
|
29
|
+
Read [`analysis_drilldown_contract.md`](analysis_drilldown_contract.md). Pass the selected report source and merge only its returned coordinate fragments for the advertised action. Do not pass raw QP.
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# analysis drilldown-entities export
|
|
2
|
+
|
|
3
|
+
Stream the complete users or custom entities behind one selected synchronous-preview coordinate as a `csv.gz` artifact.
|
|
4
|
+
|
|
5
|
+
Read [`analysis_drilldown_contract.md`](analysis_drilldown_contract.md) and first validate the coordinate with the corresponding synchronous preview/`drilldown-entities run` path. The export consumes an existing sync-preview context; it never creates a query context or additional drilldown choices.
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
ae-cli analysis drilldown-entities export \
|
|
9
|
+
--query-context-id <sync_preview_query_context_id> \
|
|
10
|
+
[--source '{"report_id":1001}'] \
|
|
11
|
+
--coordinate '<same returned coordinate>' \
|
|
12
|
+
[--properties '[{...}]'] \
|
|
13
|
+
[--artifact-format csv] \
|
|
14
|
+
[--timeout-seconds 21600]
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
Property support matches the synchronous preview exactly:
|
|
18
|
+
|
|
19
|
+
- For the `#user_id` user subject, `--properties` accepts `[{"columnName":"<property_name>","tableType":"user"}]`. The artifact always retains `#user_id`, `#account_id`, and `#distinct_id` plus the requested user properties.
|
|
20
|
+
- For a custom entity subject, omit `--properties`; the artifact contains only the entity value column. Supplying properties returns `CUSTOM_ENTITY_PROPERTIES_UNSUPPORTED` instead of silently ignoring them.
|
|
21
|
+
|
|
22
|
+
`#user_id` is an internal association key. When presenting downloaded user rows to a customer, Agents should display account ID and visitor ID by default rather than using `#user_id` as the only visible identity.
|
|
23
|
+
|
|
24
|
+
This command does not accept `--limit`, `--offset`, `--page-num`, or `--page-size`. Common executes one full-download query and streams it directly into the artifact; it does not repeatedly call the synchronous preview. “Complete” follows the platform full-download ceiling (`model_full_download_limit`). Inspect `run_id`, then download only after completion.
|
|
25
|
+
|
|
26
|
+
The file is durable member data, not a new interactive result. Do not use rows in the downloaded artifact to construct another analysis coordinate. User event continuation requires the `drilldown_context_id` and canonical `user_id` returned by a user-subject `drilldown-entities run`, not this export.
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
# analysis drilldown-entities run
|
|
2
|
+
|
|
3
|
+
Preview users or custom entities behind one selected synchronous-preview cell.
|
|
4
|
+
|
|
5
|
+
Read [`analysis_drilldown_contract.md`](analysis_drilldown_contract.md) first. Call this only when the selected metric/action advertises `drilldown_entities`. Event metrics require `analysis_angle=USER_LIST|ENTITY_LIST`; retention, funnel, distribution, interval, property, path, and attribution results expose their analysis subject in `source.drilldown.subject`.
|
|
6
|
+
|
|
7
|
+
## Command
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
ae-cli analysis drilldown-entities run \
|
|
11
|
+
--query-context-id <sync_preview_query_context_id> \
|
|
12
|
+
[--source '{"report_id":1001}'] \
|
|
13
|
+
--coordinate '<merged returned row/column/metric coordinate>' \
|
|
14
|
+
[--properties '[{...}]'] \
|
|
15
|
+
[--limit 100] \
|
|
16
|
+
[--timeout-seconds 120]
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
The context, source, and coordinate must all come from the same synchronous preview. Select a visible row from `row_options`, a drillable column from `column_options`, and the relevant metric option; shallow-merge their coordinate fragments. Never send `row_index`, `column_index`, `values`, `label`, `target_id`, raw QP, or a coordinate derived from an export file.
|
|
20
|
+
|
|
21
|
+
Property support depends on the returned subject:
|
|
22
|
+
|
|
23
|
+
- `subject.type=user` (`column_name=#user_id`): `--properties` may select additional user properties with `[{"columnName":"<property_name>","tableType":"user"}]`. The named value `user` is required; do not send numeric enum codes. Every row still contains `#user_id`, `#account_id`, and `#distinct_id`.
|
|
24
|
+
- `subject.type=entity`: do not pass `--properties`. A custom entity returns only its entity value. Supplying properties is invalid and must return `CUSTOM_ENTITY_PROPERTIES_UNSUPPORTED`; it is never silently ignored.
|
|
25
|
+
|
|
26
|
+
## Output and next intent
|
|
27
|
+
|
|
28
|
+
The response contains `subject`, `items`, `total`, `returned_rows`, and `truncated`.
|
|
29
|
+
|
|
30
|
+
- `subject.type=user`: items include canonical `user_id`; `attributes` always includes `#user_id`, `#account_id`, and `#distinct_id`, followed by requested user properties. `#user_id` is an internal association key that customers normally do not care about. In user-facing tables or summaries, show account ID and visitor ID by default and keep `#user_id` only for machine linkage or explicit troubleshooting. If `drilldown_context_id` and the user-event follow-up are present, the Agent may ask for one returned user's event sequence with `analysis drilldown-user-events run|export`.
|
|
31
|
+
- `subject.type=entity`: items contain `entity_value`; do not call user-event commands because non-user entities have no event sequence.
|
|
32
|
+
- When `truncated=true` or complete membership is requested, repeat the same context/source/coordinate with `analysis drilldown-entities export`. Do not page this command.
|
|
33
|
+
- Creating a result cluster is a sibling action from the original analysis cell, not from an entity row. Use the original `query_context_id`, source, and coordinate with `analysis query create-result-cluster` only if that action was advertised.
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# analysis drilldown-events export
|
|
2
|
+
|
|
3
|
+
Stream all raw events behind one selected `EVENT_LIST` coordinate into one `csv.gz` artifact.
|
|
4
|
+
|
|
5
|
+
Use this only when the selected synchronous preview metric advertises `drilldown_events`. Copy the same `query_context_id`, optional `source`, and semantic `coordinate` used by `analysis drilldown-events run`; never pass raw QP or `target_id`.
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
ae-cli analysis drilldown-events export \
|
|
9
|
+
--query-context-id <sync_preview_query_context_id> \
|
|
10
|
+
[--source '{"report_id":1001}'] \
|
|
11
|
+
--coordinate '<same returned coordinate>' \
|
|
12
|
+
[--properties '[{"columnName":"<event_property_name>","tableType":"event"}]'] \
|
|
13
|
+
[--artifact-format csv] \
|
|
14
|
+
[--timeout-seconds 21600]
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
This command does not accept `--limit`, `--offset`, `--page-num`, or `--page-size`. Common executes one full-download query and streams its result directly into the artifact; it does not repeatedly call the synchronous preview. “All” follows the platform full-download ceiling (`model_full_download_limit`), not an unbounded query.
|
|
18
|
+
|
|
19
|
+
When `--properties` is present, the artifact contains required system event columns plus exactly the requested event properties. The export and synchronous preview use the same projection contract.
|
|
20
|
+
|
|
21
|
+
Inspect `run_id`, wait for completion, then download the bound artifact. The downloaded rows are durable event detail only; they do not create or enlarge the interactive drilldown coordinate set.
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# analysis drilldown-events run
|
|
2
|
+
|
|
3
|
+
Preview raw event rows behind one event-analysis metric cell.
|
|
4
|
+
|
|
5
|
+
Read [`analysis_drilldown_contract.md`](analysis_drilldown_contract.md) first. Call this command only when the selected event `metric_option` has `analysis_angle=EVENT_LIST` and includes `drilldown_events` in `actions`. Event totals commonly have this angle; triggered-user/entity counts do not.
|
|
6
|
+
|
|
7
|
+
## Command
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
ae-cli analysis drilldown-events run \
|
|
11
|
+
--query-context-id <sync_preview_query_context_id> \
|
|
12
|
+
[--source '{"report_id":1001}'] \
|
|
13
|
+
--coordinate '{"group_values":["Beijing"],"date":"2026-07-16","metric_index":0}' \
|
|
14
|
+
[--properties '[{...}]'] \
|
|
15
|
+
[--limit 100] \
|
|
16
|
+
[--timeout-seconds 120]
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
`--query-context-id` must come from the same synchronous preview that returned the selected source and options. `--source` is required only to disambiguate multiple returned sources. Assemble `--coordinate` only by merging the selected returned option fragments. Do not pass `target_id`, raw QP, display-only dates, or values from an export/download.
|
|
20
|
+
|
|
21
|
+
`--properties` is an optional exact event-property projection. Omit it for default columns; string arrays such as `["#event_time"]` are invalid. Each item uses the backend field names `columnName` and `tableType`, for example `[{"columnName":"<event_property_name>","tableType":"event"}]`. `tableType` uses the documented name `event`, not a numeric enum code. Required system event columns remain present, but unrelated event properties must not be returned.
|
|
22
|
+
|
|
23
|
+
The response contains at most `limit` event rows from that selected preview cell. `total` is the exact number of matching events, `returned_rows` is the number included in this response, and `truncated=true` means more matching events exist. This command has no paging offset. When complete event detail is required, call `analysis drilldown-events export` once with the same returned context/source/coordinate; that sibling capability uses the backend full-download stream and does not page or enlarge the synchronous selection boundary.
|
|
@@ -8,13 +8,16 @@ Export the complete event sequence for one user from a drilldown context. Do not
|
|
|
8
8
|
ae-cli analysis drilldown-user-events export \
|
|
9
9
|
--drilldown-context-id <drilldown_context_id> \
|
|
10
10
|
--user-id <user_id> \
|
|
11
|
+
[--properties '[{"columnName":"<event_property_name>","tableType":"event"}]'] \
|
|
11
12
|
[--sort-order desc] \
|
|
12
|
-
[--artifact-format
|
|
13
|
+
[--artifact-format csv] \
|
|
13
14
|
[--timeout-seconds 21600]
|
|
14
15
|
```
|
|
15
16
|
|
|
16
|
-
|
|
17
|
+
The nested backend keys are exactly `columnName` and `tableType`, and the table type is the named value `event`. String-name arrays, numeric enum codes, and snake_case rewrites are invalid. With an explicit projection, the artifact retains `#user_id`, account ID, visitor ID, event name, and event time and appends exactly the requested event properties. `#user_id` is internal; Agents should normally present account ID and visitor ID to customers.
|
|
18
|
+
|
|
19
|
+
Use the exact `drilldown_context_id` and canonical `user_id` returned by a user-subject `analysis drilldown-entities run`. Do not use a custom entity, an entity export artifact, or a guessed identity. Export does not accept `--limit`, `--offset`, `--page-num`, or `--page-size`; Common builds the same authorized event-sequence query without the synchronous 1000-row preview cap and streams one `csv.gz` artifact. The platform full-download ceiling (`model_full_download_limit`) still applies.
|
|
17
20
|
|
|
18
21
|
Inspect the returned `run_id` with `analysis run inspect`, then download the completed artifact with `analysis artifact download`.
|
|
19
22
|
|
|
20
|
-
Output is an async run/artifact descriptor. The complete event rows exist only in the downloaded artifact.
|
|
23
|
+
Output is an async run/artifact descriptor. The complete event rows exist only in the downloaded artifact; they cannot be used as new analysis coordinates.
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
# analysis drilldown-user-events run
|
|
2
2
|
|
|
3
|
-
Query event sequence details for one user after `analysis drilldown-
|
|
3
|
+
Query event sequence details for one user after a user-subject `analysis drilldown-entities run`.
|
|
4
4
|
|
|
5
|
-
Use this only
|
|
5
|
+
Use this only when `analysis drilldown-entities run` returns `subject.type=user`, a `drilldown_context_id`, and the user-event follow-up action. Custom entities do not have event sequences.
|
|
6
6
|
|
|
7
7
|
Do not pass raw QP.
|
|
8
8
|
|
|
@@ -19,15 +19,15 @@ ae-cli analysis drilldown-user-events run \
|
|
|
19
19
|
|
|
20
20
|
## Input
|
|
21
21
|
|
|
22
|
-
- `--drilldown-context-id`: returned by `analysis drilldown-
|
|
23
|
-
- `--user-id`:
|
|
24
|
-
- `--properties`: optional
|
|
22
|
+
- `--drilldown-context-id`: returned by the same user-subject `analysis drilldown-entities run`.
|
|
23
|
+
- `--user-id`: canonical `user_id` from one item in that same response. Never substitute `entity_value`, `#distinct_id`, account ID, or another identity field.
|
|
24
|
+
- `--properties`: optional exact event-property projection. Omit it to use the default event columns. If present, each item uses backend keys `columnName` and `tableType`, for example `[{"columnName":"<event_property_name>","tableType":"event"}]`. `#user_id`, account ID, visitor ID, event name, and event time remain present; unrelated event properties must not be returned. `#user_id` is an internal association key, so Agents should normally display account ID and visitor ID to customers. Do not pass numeric table-type codes, string-name arrays, or snake_case nested keys.
|
|
25
25
|
- `--sort-order`: `asc` or `desc`.
|
|
26
26
|
- `--event-name-filter`, `--time-filter`, `--time-filter-before-nums`, `--time-filter-after-nums`: optional event sequence filters.
|
|
27
27
|
|
|
28
28
|
Do not use raw QP, `query_context_id`, or guessed user IDs for this command.
|
|
29
29
|
|
|
30
|
-
|
|
30
|
+
Do not call this command merely because an entity row looks like a user. The explicit subject and follow-up context are the authority.
|
|
31
31
|
|
|
32
32
|
## Output
|
|
33
33
|
|
|
@@ -26,6 +26,8 @@ Do not pass `--limit`; async export rejects inline limits. Use `--artifact-forma
|
|
|
26
26
|
|
|
27
27
|
Export does not accept `--limit` or `--offset`; backend batching is internal.
|
|
28
28
|
|
|
29
|
+
For `entity="user"`, every artifact row includes `#user_id`, `#account_id`, and `#distinct_id` plus requested user properties. For a custom entity, omit `properties`; the artifact contains only the entity value column and rejects additional properties. When presenting user artifacts, Agents should display account ID and visitor ID instead of exposing internal `#user_id` as the only visible identity.
|
|
30
|
+
|
|
29
31
|
Output:
|
|
30
32
|
|
|
31
33
|
Returns an async descriptor with opaque `run_id` / `artifact_id`, lifecycle status, expiration, and effective timeout/deadline fields. JSONL artifacts start with metadata and schema lines; CSV artifacts start directly with the header and contain only valid CSV records.
|
|
@@ -9,7 +9,7 @@ Use this command for the first small entity detail preview that fits inline. It
|
|
|
9
9
|
```bash
|
|
10
10
|
ae-cli analysis entity-detail run \
|
|
11
11
|
--project-id <project_id> \
|
|
12
|
-
--definition '{"entity":"user","cohort":{"relation":"and","items":[{"field":{"name":"level","type":"user_property"},"operator":"gte","values":[1]}]},"properties":[
|
|
12
|
+
--definition '{"entity":"user","cohort":{"relation":"and","items":[{"field":{"name":"level","type":"user_property"},"operator":"gte","values":[1]}]},"properties":[{"name":"country","type":"user_property"}],"sort":[{"field":"#user_id","order":"asc"}]}' \
|
|
13
13
|
--limit 100
|
|
14
14
|
```
|
|
15
15
|
|
|
@@ -24,6 +24,13 @@ Input:
|
|
|
24
24
|
|
|
25
25
|
`entity` may be `"user"` for the default user entity or `{ "id": 123 }` in multi-entity projects.
|
|
26
26
|
|
|
27
|
+
Property and identity rules depend on the entity:
|
|
28
|
+
|
|
29
|
+
- `entity="user"` resolves to the `#user_id` user entity. `properties` may contain user properties. Every row always contains `#user_id`, `#account_id`, and `#distinct_id` plus the requested properties.
|
|
30
|
+
- A custom entity (`{"id":123}` whose entity column is not `#user_id`) returns only its entity value column. Do not provide `properties`; doing so returns `CUSTOM_ENTITY_PROPERTIES_UNSUPPORTED`.
|
|
31
|
+
|
|
32
|
+
`#user_id` is an internal association key and is normally not meaningful to customers. In user-facing output, Agents should show account ID and visitor ID by default; retain `#user_id` for machine linkage or explicit troubleshooting.
|
|
33
|
+
|
|
27
34
|
`cohort` is AI-facing for simple entity-set filters and uses the same filter item shape as report/detail filters:
|
|
28
35
|
|
|
29
36
|
```json
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# tracking event-blacklist add
|
|
2
|
+
|
|
3
|
+
Use when add events to tracking event blacklist.
|
|
4
|
+
|
|
5
|
+
Do not use for commands listed under the sheet's non-CLI section or for unrelated metadata/report operations. If the command needs a complex JSON object, read the backend schema or existing asset first and send snake_case fields only.
|
|
6
|
+
|
|
7
|
+
Command:
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
ae-cli tracking event-blacklist add [options]
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Capability id: `tracking.event_blacklist.add`
|
|
14
|
+
|
|
15
|
+
Input sends `project_id` and `event_names`. Do not send camelCase aliases.
|
|
16
|
+
|
|
17
|
+
Output is the capability gateway envelope: success is `ok=true,data,meta`; failure is `ok=false,error`. Export commands return lifecycle data such as `run_id` and `artifact_id` for inspect/download.
|
|
18
|
+
|
|
19
|
+
Parameters:
|
|
20
|
+
|
|
21
|
+
| Parameter | Description | Required |
|
|
22
|
+
| --- | --- | --- |
|
|
23
|
+
| `--project-id` | See command help | Yes |
|
|
24
|
+
| `--event-names` | See command help | Yes |
|
|
25
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# tracking event-blacklist list
|
|
2
|
+
|
|
3
|
+
Use when list tracking event blacklist configuration.
|
|
4
|
+
|
|
5
|
+
Do not use for commands listed under the sheet's non-CLI section or for unrelated metadata/report operations. If the command needs a complex JSON object, read the backend schema or existing asset first and send snake_case fields only.
|
|
6
|
+
|
|
7
|
+
Command:
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
ae-cli tracking event-blacklist list [options]
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Capability id: `tracking.event_blacklist.list`
|
|
14
|
+
|
|
15
|
+
Input sends `project_id`. Do not send camelCase aliases.
|
|
16
|
+
|
|
17
|
+
Output is the capability gateway envelope: success is `ok=true,data,meta`; failure is `ok=false,error`. Export commands return lifecycle data such as `run_id` and `artifact_id` for inspect/download.
|
|
18
|
+
|
|
19
|
+
Parameters:
|
|
20
|
+
|
|
21
|
+
| Parameter | Description | Required |
|
|
22
|
+
| --- | --- | --- |
|
|
23
|
+
| `--project-id` | See command help | Yes |
|
|
24
|
+
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# tracking event-blacklist update
|
|
2
|
+
|
|
3
|
+
Use when update tracking event blacklist config.
|
|
4
|
+
|
|
5
|
+
Do not use for commands listed under the sheet's non-CLI section or for unrelated metadata/report operations. If the command needs a complex JSON object, read the backend schema or existing asset first and send snake_case fields only.
|
|
6
|
+
|
|
7
|
+
Command:
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
ae-cli tracking event-blacklist update [options]
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Capability id: `tracking.event_blacklist.update`
|
|
14
|
+
|
|
15
|
+
Input sends `project_id`, `event_names`, and `type`. Do not send camelCase aliases.
|
|
16
|
+
|
|
17
|
+
Output is the capability gateway envelope: success is `ok=true,data,meta`; failure is `ok=false,error`. Export commands return lifecycle data such as `run_id` and `artifact_id` for inspect/download.
|
|
18
|
+
|
|
19
|
+
Parameters:
|
|
20
|
+
|
|
21
|
+
| Parameter | Description | Required |
|
|
22
|
+
| --- | --- | --- |
|
|
23
|
+
| `--project-id` | See command help | Yes |
|
|
24
|
+
| `--event-names` | See command help | Yes |
|
|
25
|
+
| `--type` | See command help | Yes |
|
|
26
|
+
|
|
@@ -26,6 +26,8 @@ Do not pass `--limit`; async export rejects inline limits. Use `--artifact-forma
|
|
|
26
26
|
|
|
27
27
|
Export does not accept `--limit` or `--offset`; backend batching is internal.
|
|
28
28
|
|
|
29
|
+
`definition.properties` uses the same exact projection as `event-detail run`. The artifact may include required system event columns, but it must not expand to every visible event property.
|
|
30
|
+
|
|
29
31
|
Output:
|
|
30
32
|
|
|
31
33
|
Returns an async descriptor with opaque `run_id` / `artifact_id`, lifecycle status, expiration, and effective timeout/deadline fields. JSONL artifacts start with metadata and schema lines; CSV artifacts start directly with the header and contain only valid CSV records.
|
|
@@ -51,6 +51,8 @@ Use `{"mode":"relative","relative_date_range":"0-7"}` for recent-day queries.
|
|
|
51
51
|
|
|
52
52
|
Do not pass raw QP, `eventView`, `taFilters`, `columnName`, or `tableType`.
|
|
53
53
|
|
|
54
|
+
When `definition.properties` is present, it is an exact projection: required system event columns remain, requested properties are appended, and unrelated properties must not be returned.
|
|
55
|
+
|
|
54
56
|
Do not use this command for full, unknown-size, or later-page detail retrieval. Use `analysis event-detail export` and check its artifact metadata for `truncated`.
|
|
55
57
|
|
|
56
58
|
Output:
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# analysis-meta event list
|
|
2
2
|
|
|
3
|
-
Use when the user needs to list project super events.
|
|
3
|
+
Use when the user needs to list project super events, search event metadata, page results, project fields, or filter to authenticated events.
|
|
4
4
|
|
|
5
5
|
Do not use it for raw tracked events, event counts, or one full definition; it lists project super-event metadata.
|
|
6
6
|
|
|
@@ -8,12 +8,15 @@ Command:
|
|
|
8
8
|
|
|
9
9
|
```bash
|
|
10
10
|
ae-cli analysis-meta event list --project-id <project_id>
|
|
11
|
+
ae-cli analysis-meta event list --project-id <project_id> --query login --fields '["event_name","event_desc","authentication_status"]' --limit 20 --offset 0 --authenticated-only
|
|
11
12
|
ae-cli analysis-meta event list --dry-run
|
|
12
13
|
```
|
|
13
14
|
|
|
14
15
|
Capability id: `metadata.event.list`.
|
|
15
16
|
|
|
16
|
-
Input sends `project_id`.
|
|
17
|
+
Input sends `project_id`, `query`, `fields`, `limit`, `offset`, and `authenticated_only`.
|
|
18
|
+
|
|
19
|
+
Use snake_case projection fields: `event_id`, `event_name`, `event_desc`, `remark`, `event_tag`, `authentication_status`. Do not send legacy camelCase field names.
|
|
17
20
|
|
|
18
21
|
Output `data.events[]` contains project super-event metadata records.
|
|
19
22
|
|
|
@@ -21,3 +24,8 @@ Output `data.events[]` contains project super-event metadata records.
|
|
|
21
24
|
| Parameter | Required | Description |
|
|
22
25
|
|---|---|---|
|
|
23
26
|
| `--project-id` | Yes | Numeric project ID. |
|
|
27
|
+
| `--query` / `-q` | No | Optional keyword filter. Fuzzy match is applied to `event_name`, `event_desc`, and `remark`. |
|
|
28
|
+
| `--fields` / `-f` | No | Optional JSON array of snake_case fields to return. |
|
|
29
|
+
| `--limit` / `-l` | No | Optional page size. When omitted, existing full-list behavior is preserved. Maximum: 50. |
|
|
30
|
+
| `--offset` / `-o` | No | Optional zero-based page offset. |
|
|
31
|
+
| `--authenticated-only` | No | When true, return only authenticated events and include `authentication_status` when projected. |
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# tracking ingest-error list
|
|
2
|
+
|
|
3
|
+
Use when list tracking ingest errors for one data name.
|
|
4
|
+
|
|
5
|
+
Do not use for commands listed under the sheet's non-CLI section or for unrelated metadata/report operations. If the command needs a complex JSON object, read the backend schema or existing asset first and send snake_case fields only.
|
|
6
|
+
|
|
7
|
+
Command:
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
ae-cli tracking ingest-error list [options]
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Capability id: `tracking.ingest_error.list`
|
|
14
|
+
|
|
15
|
+
Input sends `project_id`, `data_name`, `start_time`, and `end_time`. Do not send camelCase aliases.
|
|
16
|
+
|
|
17
|
+
Output is the capability gateway envelope: success is `ok=true,data,meta`; failure is `ok=false,error`. Export commands return lifecycle data such as `run_id` and `artifact_id` for inspect/download.
|
|
18
|
+
|
|
19
|
+
Parameters:
|
|
20
|
+
|
|
21
|
+
| Parameter | Description | Required |
|
|
22
|
+
| --- | --- | --- |
|
|
23
|
+
| `--project-id` | See command help | Yes |
|
|
24
|
+
| `--data-name` | See command help | Yes |
|
|
25
|
+
| `--start-time` | See command help | No |
|
|
26
|
+
| `--end-time` | See command help | No |
|
|
27
|
+
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# tracking ingest summary
|
|
2
|
+
|
|
3
|
+
Use when get tracking ingest summary.
|
|
4
|
+
|
|
5
|
+
Do not use for commands listed under the sheet's non-CLI section or for unrelated metadata/report operations. If the command needs a complex JSON object, read the backend schema or existing asset first and send snake_case fields only.
|
|
6
|
+
|
|
7
|
+
Command:
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
ae-cli tracking ingest summary [options]
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Capability id: `tracking.ingest.summary`
|
|
14
|
+
|
|
15
|
+
Input sends `project_id`, `start_time`, and `end_time`. Do not send camelCase aliases.
|
|
16
|
+
|
|
17
|
+
Output is the capability gateway envelope: success is `ok=true,data,meta`; failure is `ok=false,error`. Export commands return lifecycle data such as `run_id` and `artifact_id` for inspect/download.
|
|
18
|
+
|
|
19
|
+
Parameters:
|
|
20
|
+
|
|
21
|
+
| Parameter | Description | Required |
|
|
22
|
+
| --- | --- | --- |
|
|
23
|
+
| `--project-id` | See command help | Yes |
|
|
24
|
+
| `--start-time` | See command help | No |
|
|
25
|
+
| `--end-time` | See command help | No |
|
|
26
|
+
|
|
@@ -39,4 +39,4 @@ ae-cli analysis_meta +list_entities --dry-run
|
|
|
39
39
|
- If the result is empty, first confirm the project ID/keyword, then try loosening the filter conditions.
|
|
40
40
|
|
|
41
41
|
## Recommended Chaining
|
|
42
|
-
- +list_entities ->
|
|
42
|
+
- +list_entities -> analysis-meta virtual-property create / analysis-meta virtual-event create
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# tracking live-data export
|
|
2
|
+
|
|
3
|
+
Use when export recent tracking live data.
|
|
4
|
+
|
|
5
|
+
Do not use for commands listed under the sheet's non-CLI section or for unrelated metadata/report operations. If the command needs a complex JSON object, read the backend schema or existing asset first and send snake_case fields only.
|
|
6
|
+
|
|
7
|
+
Command:
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
ae-cli tracking live-data export [options]
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Capability id: `tracking.live_data.export`
|
|
14
|
+
|
|
15
|
+
Input sends `project_id`, optional `data_type`, optional `request_id`, and optional `timeout_seconds`. Do not send camelCase aliases.
|
|
16
|
+
|
|
17
|
+
Output is the capability gateway envelope: success is `ok=true,data,meta`; failure is `ok=false,error`. Export commands return lifecycle data such as `run_id` and `artifact_id` for inspect/download.
|
|
18
|
+
|
|
19
|
+
Parameters:
|
|
20
|
+
|
|
21
|
+
| Parameter | Description | Required |
|
|
22
|
+
| --- | --- | --- |
|
|
23
|
+
| `--project-id` | See command help | Yes |
|
|
24
|
+
| `--data-type` | See command help | No |
|
|
25
|
+
| `--request-id` | See command help | No |
|
|
26
|
+
| `--async-timeout-seconds` | See command help | No |
|
|
27
|
+
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# tracking live-data list
|
|
2
|
+
|
|
3
|
+
Use when list recent tracking live data.
|
|
4
|
+
|
|
5
|
+
Do not use for commands listed under the sheet's non-CLI section or for unrelated metadata/report operations. If the command needs a complex JSON object, read the backend schema or existing asset first and send snake_case fields only.
|
|
6
|
+
|
|
7
|
+
Command:
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
ae-cli tracking live-data list [options]
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Capability id: `tracking.live_data.list`
|
|
14
|
+
|
|
15
|
+
Input sends `project_id`, optional `data_type`, optional `request_id`, and optional `timeout_seconds`. Do not send camelCase aliases.
|
|
16
|
+
|
|
17
|
+
Output is the capability gateway envelope: success is `ok=true,data,meta`; failure is `ok=false,error`. Export commands return lifecycle data such as `run_id` and `artifact_id` for inspect/download.
|
|
18
|
+
|
|
19
|
+
Parameters:
|
|
20
|
+
|
|
21
|
+
| Parameter | Description | Required |
|
|
22
|
+
| --- | --- | --- |
|
|
23
|
+
| `--project-id` | See command help | Yes |
|
|
24
|
+
| `--data-type` | See command help | No |
|
|
25
|
+
| `--request-id` | See command help | No |
|
|
26
|
+
| `--timeout-seconds` | See command help | No |
|
|
27
|
+
|
|
@@ -2,13 +2,14 @@
|
|
|
2
2
|
|
|
3
3
|
Use when the user needs to create a metric from event or retention analysis configuration.
|
|
4
4
|
|
|
5
|
-
Do not use it to query metric values. Use this gateway command for an exact metric definition
|
|
5
|
+
Do not use it to query metric values. Use this gateway command for an exact metric definition.
|
|
6
6
|
|
|
7
7
|
Command:
|
|
8
8
|
|
|
9
9
|
```bash
|
|
10
|
-
ae-cli analysis-meta metric create --project-id <project_id> --metric-name pay_amount --metric-desc 'Pay Amount' --
|
|
11
|
-
ae-cli analysis-meta metric create --project-id <project_id> --metric-name
|
|
10
|
+
ae-cli analysis-meta metric create --project-id <project_id> --metric-name pay_amount --metric-desc 'Pay Amount' --model-type event --metric-events '[...]' --metric-params '{}'
|
|
11
|
+
ae-cli analysis-meta metric create --project-id <project_id> --metric-name retained_users --metric-desc 'Retained Users' --model-type retention --metric-events '[...]' --metric-params '{}'
|
|
12
|
+
ae-cli analysis-meta metric create --project-id <project_id> --metric-name pay_amount --metric-desc 'Pay Amount' --metric-mode 0 --metric-events '[...]' --dry-run
|
|
12
13
|
```
|
|
13
14
|
|
|
14
15
|
Capability id: `metadata.metric.create`.
|
|
@@ -23,7 +24,15 @@ Output `data.metric` contains the created metric summary.
|
|
|
23
24
|
| `--project-id` | Yes | Numeric project ID. |
|
|
24
25
|
| `--metric-name` | Yes | Metric technical name. |
|
|
25
26
|
| `--metric-desc` | Yes | Metric display name. |
|
|
26
|
-
| `--
|
|
27
|
+
| `--model-type` | No | Semantic metric model type: `event` or `retention`. Prefer this over `--metric-mode`. |
|
|
28
|
+
| `--metric-mode` | No | Metric model mode, for example `0` for event analysis. Required only when `--model-type` is omitted. |
|
|
27
29
|
| `--metric-events` | Yes | Metric event-analysis QP JSON array. |
|
|
28
30
|
| `--metric-remark` | No | Metric remark. |
|
|
29
31
|
| `--metric-params` | No | Metric params JSON object; common defaults it to `{}` when needed. |
|
|
32
|
+
|
|
33
|
+
## Decision Rules
|
|
34
|
+
|
|
35
|
+
- Pass exactly one semantic model selector when possible: prefer `--model-type event` or `--model-type retention`.
|
|
36
|
+
- `--metric-mode` remains available for existing scripts; if both are provided, they must describe the same model.
|
|
37
|
+
- For event metrics, `--metric-params` is usually a format config such as `{"format":"integer"}`.
|
|
38
|
+
- For retention metrics, `--metric-params` should be the retention `eventView` configuration.
|
|
@@ -23,3 +23,10 @@ Output is a successful gateway envelope with no business data. Verify with `metr
|
|
|
23
23
|
|---|---|---|
|
|
24
24
|
| `--project-id` | Yes | Numeric project ID. |
|
|
25
25
|
| `--metric-id` | Yes | Metric ID. |
|
|
26
|
+
|
|
27
|
+
## Decision Rules
|
|
28
|
+
- Use `analysis-meta metric list` first to confirm the metric ID before deleting.
|
|
29
|
+
- This is a destructive operation; keep the confirmation prompt unless automation is explicitly required.
|
|
30
|
+
|
|
31
|
+
## Recommended Chain
|
|
32
|
+
- `analysis-meta metric list` -> `analysis-meta metric delete`
|