@thinkingai/ae-cli 6.0.24 → 6.0.28
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/dist/{auth-A2XXG5K4.js → auth-7TQRGLBC.js} +10 -8
- package/dist/{auth-IDPKDFSY.js → auth-MEJ642P4.js} +2 -2
- package/dist/chunk-2NDGFQHW.js +190 -0
- package/dist/{chunk-NGJDCOYA.js → chunk-7QQ4233A.js} +3 -3
- package/dist/{chunk-PFJFZVCK.js → chunk-AJTH7LT3.js} +3 -2
- package/dist/{chunk-V5R5UIRM.js → chunk-BXMXMUD7.js} +65 -6
- package/dist/{chunk-AKORWVHJ.js → chunk-C4DH76LX.js} +1 -1
- package/dist/{chunk-NXJP4CES.js → chunk-GWZ5MYWE.js} +3 -3
- package/dist/{chunk-F3ZDMC2W.js → chunk-KCA6BA5D.js} +2 -2
- package/dist/{chunk-WXBCP6SD.js → chunk-KGJQCYVC.js} +1 -1
- package/dist/{chunk-FIT4CFIN.js → chunk-LG5YT7P7.js} +1 -1
- package/dist/{chunk-IDXW6MEJ.js → chunk-MDJGDI6K.js} +2 -2
- package/dist/{chunk-4FQ36OGO.js → chunk-R77JT7XD.js} +53 -6
- package/dist/{chunk-65DKFJZB.js → chunk-YCLVYFK7.js} +49 -6
- package/dist/{chunk-2OW2RENH.js → chunk-YNQFYBDB.js} +64 -6
- package/dist/{chunk-ONOA6DYB.js → chunk-ZAOL36CG.js} +1 -1
- package/dist/cli-token-TVQRSE46.js +18 -0
- package/dist/{client-7L735LVY.js → client-2643Z5AG.js} +3 -3
- package/dist/{config-SXD2JKSL.js → config-ZVPARN4R.js} +4 -9
- package/dist/index.js +24 -24
- package/dist/{metadata-QWUAX625.js → metadata-IPSPQBX3.js} +5 -5
- package/dist/{metadata-XWTEGEN2.js → metadata-N5REJ7R7.js} +5 -5
- package/dist/{model-3OVX42DA.js → model-T3KZJWLW.js} +2 -2
- package/dist/{raw-IANB4AV5.js → raw-OHSUK42D.js} +4 -4
- package/dist/{sync-4HQ3CXSK.js → sync-ULT5SECP.js} +3 -3
- package/dist/{te-agent-OYNNTJDU.js → te-agent-QLIVKRUN.js} +1146 -61
- package/dist/{te-analysis-JX3V76OI.js → te-analysis-5WZKVFHI.js} +1332 -338
- package/dist/{te-analysis-CRPFK3LX.js → te-analysis-KAEZXLNS.js} +1332 -338
- package/dist/{te-audience-RO2IZOUC.js → te-audience-PVMKQAFH.js} +5 -5
- package/dist/{te-audience-77FGNG5E.js → te-audience-XMRMVD2V.js} +5 -5
- package/dist/{te-common-4TRJPRC5.js → te-common-CFGQXTFV.js} +5 -5
- package/dist/{te-common-PUXBUPOL.js → te-common-SDB3O2QG.js} +5 -5
- package/dist/{te-community-XKE526DS.js → te-community-6A7LKYUH.js} +5 -5
- package/dist/{te-community-NPDZQKMY.js → te-community-GMWFGILT.js} +5 -5
- package/dist/{te-dataops-PW74WP76.js → te-dataops-6LIPYNGH.js} +90 -68
- package/dist/{te-dataops-6KWLFNV4.js → te-dataops-Z53CTG2U.js} +90 -68
- package/dist/{te-engage-HTLMUN7G.js → te-engage-AGREUOW7.js} +30 -15
- package/dist/{te-engage-YPQIVF5H.js → te-engage-MIIUKY6M.js} +30 -15
- package/dist/{te-kb-DOGDQIU4.js → te-kb-KQJ53M3A.js} +4 -4
- package/dist/{te-meta-5ESSQ5B3.js → te-meta-QLANJ4B4.js} +5 -5
- package/dist/{te-meta-Z47X4VT3.js → te-meta-TOA6FWDE.js} +5 -5
- package/dist/{te-team-SOVKZIDD.js → te-team-TQGMNHQQ.js} +5 -5
- package/package.json +3 -1
- package/skills/ae-agent/SKILL.md +158 -189
- package/skills/ae-agent/references/accept-skill-share.md +39 -0
- package/skills/ae-agent/references/add-attachment.md +57 -0
- package/skills/ae-agent/references/add-mcp.md +75 -0
- package/skills/ae-agent/references/add-model.md +70 -0
- package/skills/ae-agent/references/add-skill.md +71 -0
- package/skills/ae-agent/references/approve-skill.md +41 -0
- package/skills/ae-agent/references/attachment-stats.md +50 -0
- package/skills/ae-agent/references/auto-provision-mcp-credentials.md +57 -0
- package/skills/ae-agent/references/cancel-skill-submission.md +39 -0
- package/skills/ae-agent/references/copy-skill.md +53 -0
- package/skills/ae-agent/references/create-agent.md +71 -0
- package/skills/ae-agent/references/create-automation.md +99 -0
- package/skills/ae-agent/references/del-agent.md +38 -0
- package/skills/ae-agent/references/del-attachment.md +35 -0
- package/skills/ae-agent/references/del-mcp.md +35 -0
- package/skills/ae-agent/references/del-model.md +37 -0
- package/skills/ae-agent/references/del-skill-asset.md +41 -0
- package/skills/ae-agent/references/del-skill-reference.md +41 -0
- package/skills/ae-agent/references/del-skill-script.md +41 -0
- package/skills/ae-agent/references/del-skill.md +36 -0
- package/skills/ae-agent/references/edit-skill.md +64 -0
- package/skills/ae-agent/references/get-agent.md +37 -0
- package/skills/ae-agent/references/get-skill-content.md +36 -0
- package/skills/ae-agent/references/list-agents.md +40 -0
- package/skills/ae-agent/references/list-attachments.md +42 -0
- package/skills/ae-agent/references/list-automations.md +41 -0
- package/skills/ae-agent/references/list-mcp-credentials.md +65 -0
- package/skills/ae-agent/references/list-mcp-market.md +58 -0
- package/skills/ae-agent/references/list-mcps.md +37 -0
- package/skills/ae-agent/references/list-models.md +38 -0
- package/skills/ae-agent/references/list-skill-assets.md +35 -0
- package/skills/ae-agent/references/list-skill-market.md +59 -0
- package/skills/ae-agent/references/list-skill-references.md +36 -0
- package/skills/ae-agent/references/list-skill-scripts.md +35 -0
- package/skills/ae-agent/references/list-skill-shares.md +49 -0
- package/skills/ae-agent/references/list-skill-submissions.md +45 -0
- package/skills/ae-agent/references/list-skills.md +37 -0
- package/skills/ae-agent/references/mcp-auth-disconnect.md +50 -0
- package/skills/ae-agent/references/mcp-auth-start.md +61 -0
- package/skills/ae-agent/references/mcp-auth-status.md +56 -0
- package/skills/ae-agent/references/mcp-stats.md +68 -0
- package/skills/ae-agent/references/mcp-token.md +63 -0
- package/skills/ae-agent/references/mcp-tools.md +55 -0
- package/skills/ae-agent/references/read-skill-asset.md +51 -0
- package/skills/ae-agent/references/read-skill-reference.md +50 -0
- package/skills/ae-agent/references/read-skill-script.md +51 -0
- package/skills/ae-agent/references/reject-skill-share.md +37 -0
- package/skills/ae-agent/references/reject-skill.md +42 -0
- package/skills/ae-agent/references/rescan-skills.md +44 -0
- package/skills/ae-agent/references/set-mcp-credential.md +67 -0
- package/skills/ae-agent/references/set-mcp-meta.md +52 -0
- package/skills/ae-agent/references/set-skill-meta.md +51 -0
- package/skills/ae-agent/references/share-skill.md +50 -0
- package/skills/ae-agent/references/submit-skill.md +51 -0
- package/skills/ae-agent/references/test-model.md +61 -0
- package/skills/ae-agent/references/toggle-mcp.md +39 -0
- package/skills/ae-agent/references/toggle-model.md +37 -0
- package/skills/ae-agent/references/toggle-skill.md +37 -0
- package/skills/ae-agent/references/update-agent.md +71 -0
- package/skills/ae-agent/references/update-automation.md +83 -0
- package/skills/ae-agent/references/update-mcp.md +79 -0
- package/skills/ae-agent/references/update-model.md +77 -0
- package/skills/ae-agent/references/upload-skill-asset.md +49 -0
- package/skills/ae-agent/references/upload-skill-reference.md +51 -0
- package/skills/ae-agent/references/upload-skill-script.md +49 -0
- package/skills/ae-agent/references/upload-skill.md +89 -0
- package/skills/ae-analysis/SKILL.md +60 -6
- package/skills/ae-analysis/references/analysis_gateway_assets.md +27 -10
- package/skills/ae-analysis/references/artifact_download.md +17 -0
- package/skills/ae-analysis/references/asset_abnormal_get.md +27 -0
- package/skills/ae-analysis/references/asset_abnormal_list.md +24 -0
- package/skills/ae-analysis/references/asset_authentication_list.md +23 -0
- package/skills/ae-analysis/references/asset_authentication_update.md +24 -0
- package/skills/ae-analysis/references/asset_recent_list.md +24 -0
- package/skills/ae-analysis/references/asset_search.md +24 -0
- package/skills/ae-analysis/references/bi_panel_get.md +5 -0
- package/skills/ae-analysis/references/bi_panel_page_data_export.md +11 -1
- package/skills/ae-analysis/references/bi_panel_share.md +6 -0
- package/skills/ae-analysis/references/bi_panel_update.md +4 -1
- package/skills/ae-analysis/references/bi_panel_version_get.md +23 -0
- package/skills/ae-analysis/references/bi_panel_version_publish.md +20 -0
- package/skills/ae-analysis/references/dashboard_copy.md +3 -1
- package/skills/ae-analysis/references/dashboard_daily_report_send.md +9 -2
- package/skills/ae-analysis/references/dashboard_daily_report_update.md +3 -1
- package/skills/ae-analysis/references/dashboard_definition_export.md +21 -3
- package/skills/ae-analysis/references/dashboard_report_data_export.md +17 -1
- package/skills/ae-analysis/references/dashboard_report_data_run.md +6 -0
- package/skills/ae-analysis/references/datatable_columns_get.md +24 -0
- package/skills/ae-analysis/references/datatable_influence_list.md +24 -0
- package/skills/ae-analysis/references/datatable_version_get.md +24 -0
- package/skills/ae-analysis/references/datatable_version_list.md +24 -0
- package/skills/ae-analysis/references/event_changelog_list.md +24 -0
- package/skills/ae-analysis/references/event_create.md +24 -0
- package/skills/ae-analysis/references/event_delete.md +24 -0
- package/skills/ae-analysis/references/event_get.md +24 -0
- package/skills/ae-analysis/references/event_hide_update.md +25 -0
- package/skills/ae-analysis/references/event_influence_list.md +24 -0
- package/skills/ae-analysis/references/event_list.md +23 -0
- package/skills/ae-analysis/references/event_relation_update.md +24 -0
- package/skills/ae-analysis/references/event_update.md +26 -0
- package/skills/ae-analysis/references/exchange_config_update.md +24 -0
- package/skills/ae-analysis/references/exchange_rate_refresh.md +23 -0
- package/skills/ae-analysis/references/exchange_rule_list.md +23 -0
- package/skills/ae-analysis/references/exchange_rule_update.md +24 -0
- package/skills/ae-analysis/references/exchange_rule_validate.md +24 -0
- package/skills/ae-analysis/references/metric_create.md +24 -0
- package/skills/ae-analysis/references/metric_delete.md +24 -0
- package/skills/ae-analysis/references/metric_get.md +24 -0
- package/skills/ae-analysis/references/metric_list.md +24 -0
- package/skills/ae-analysis/references/metric_update.md +24 -0
- package/skills/ae-analysis/references/project_space_create.md +1 -1
- package/skills/ae-analysis/references/property_changelog_list.md +25 -0
- package/skills/ae-analysis/references/property_create.md +25 -0
- package/skills/ae-analysis/references/property_delete.md +25 -0
- package/skills/ae-analysis/references/property_get.md +25 -0
- package/skills/ae-analysis/references/property_hide_update.md +26 -0
- package/skills/ae-analysis/references/property_influence_list.md +25 -0
- package/skills/ae-analysis/references/property_list.md +24 -0
- package/skills/ae-analysis/references/property_related_events.md +24 -0
- package/skills/ae-analysis/references/property_relation_update.md +25 -0
- package/skills/ae-analysis/references/property_update.md +27 -0
- package/skills/ae-analysis/references/run_inspect.md +22 -0
- package/skills/ae-analysis/references/super_metadata_export.md +36 -0
- package/skills/ae-analysis/references/super_metadata_import.md +24 -0
- package/skills/ae-analysis/references/virtual_event_create.md +25 -0
- package/skills/ae-analysis/references/virtual_event_delete.md +24 -0
- package/skills/ae-analysis/references/virtual_event_get.md +24 -0
- package/skills/ae-analysis/references/virtual_property_create.md +24 -0
- package/skills/ae-analysis/references/virtual_property_sql_rule_delete.md +25 -0
- package/skills/ae-analysis/references/virtual_property_sql_rule_update.md +24 -0
- package/skills/ae-dataops/references/dataops-flow-create.md +2 -2
- package/skills/ae-dataops/references/dataops-flow-monitor.md +3 -3
- package/skills/ae-dataops/references/dataops-integration.md +1 -0
- package/skills/ae-engage/references/flow-node-config-schema.md +32 -8
- package/skills/ae-engage/references/save-flow.md +65 -29
- package/skills/ae-engage/references/validate-flow-node-config.md +28 -10
- package/skills/ae-generate-tracking-code/SKILL.md +16 -1
- package/skills/ae-generate-tracking-code/references/snippet-delivery.md +17 -1
- package/skills/ae-generate-tracking-plan/SKILL.md +36 -12
- package/dist/chunk-OCQPQYHZ.js +0 -105
- package/dist/cli-token-OZXHC3U2.js +0 -14
|
@@ -72,7 +72,10 @@ ae-cli analysis dashboard list --project-id <project_id>
|
|
|
72
72
|
ae-cli analysis dashboard get --project-id <project_id> --dashboard-id <dashboard_id>
|
|
73
73
|
ae-cli analysis dashboard update --project-id <project_id> --operation settings --dashboard-id <dashboard_id> --payload '{...}'
|
|
74
74
|
ae-cli analysis dashboard-report-data export --project-id <project_id> --dashboard-id <dashboard_id>
|
|
75
|
+
ae-cli analysis run inspect --run-id <run_id>
|
|
76
|
+
ae-cli analysis artifact download --run-id <run_id> --artifact-id <artifact_id> --output <file>
|
|
75
77
|
ae-cli analysis bi-panel-page-data run --project-id <project_id> --panel-id <panel_id> --page-key <page_key> --result-type charts
|
|
78
|
+
ae-cli analysis bi-panel-version get --project-id <project_id> --panel-id <panel_id> --version-type draft
|
|
76
79
|
ae-cli analysis project-space list --project-id <project_id>
|
|
77
80
|
ae-cli analysis query cancel --run-id <run_id>
|
|
78
81
|
```
|
|
@@ -83,13 +86,13 @@ Use capability-gateway asset commands when the user wants to manage or inspect:
|
|
|
83
86
|
- Dashboard report data that may be large or long-running. Prefer `dashboard-report-data export` for large results; use `run` only for bounded inline results.
|
|
84
87
|
- Dashboard definition export/import. Use `dashboard-definition import --validate-only true` for import pre-checks; do not look for a separate import-check command.
|
|
85
88
|
- Dashboard daily report update or immediate send.
|
|
86
|
-
- BI panel list/detail/create/update/delete/share/copy and BI page data. Prefer `bi-panel-page-data export` for large results.
|
|
89
|
+
- BI panel list/detail/create/update/delete/share/copy, BI panel release/draft version get/publish, and BI page data. Prefer `bi-panel-page-data export` for large results.
|
|
87
90
|
- Project spaces, folders, favorites, and public links.
|
|
88
91
|
|
|
89
92
|
Do **not** use these commands for:
|
|
90
93
|
|
|
91
94
|
- Ad-hoc model analysis, report definition, report data, drilldown, entity/event details, metadata/schema helpers, alerts, audience clusters/tags, or project lookup. Use the existing `+<tool_name>` commands for those.
|
|
92
|
-
- Dashboard locks, BI panel
|
|
95
|
+
- Dashboard locks, BI panel lock, dashboard filter module, UI reorder/move/tree operations, daily report retry/download/get-config, public-link logs/source-list/get, or other product-manager-red-marked abilities.
|
|
93
96
|
- Internal-only or UI-only payloads unless the gateway command reference explicitly exposes them through `--payload`.
|
|
94
97
|
|
|
95
98
|
Capability-gateway output:
|
|
@@ -97,7 +100,7 @@ Capability-gateway output:
|
|
|
97
100
|
- Successful commands return the standard gateway envelope: `{ "ok": true, "data": ..., "meta": ... }`.
|
|
98
101
|
- Failed commands return `{ "ok": false, "error": ... }` and exit non-zero.
|
|
99
102
|
- Inline `run` data is bounded by `--limit` and `--timeout-seconds`.
|
|
100
|
-
- Export commands return `run_id`, `artifact_id`,
|
|
103
|
+
- Export commands return `run_id`, `artifact_id`, status fields, and expiration fields. Use `--artifact-format jsonl` for the artifact format; `--format` is reserved for CLI output formatting. Poll with `ae-cli analysis run inspect --run-id <run_id>` until the run and artifact are complete, then download with `ae-cli analysis artifact download --run-id <run_id> --artifact-id <artifact_id> --output <file>`. Do not call raw inspect/download API paths directly. Cancel with `ae-cli analysis query cancel --run-id <run_id>`.
|
|
101
104
|
- Unknown input fields and camelCase external fields are rejected by the gateway; use kebab-case CLI flags only.
|
|
102
105
|
|
|
103
106
|
See [`references/analysis_gateway_assets.md`](references/analysis_gateway_assets.md) for the command matrix. Before running one command, read its dedicated reference file named as `<resource>_<action>.md`.
|
|
@@ -359,7 +362,58 @@ After outputting attribution results, verify that dimension contributions sum to
|
|
|
359
362
|
|
|
360
363
|
## Tool Groups (100)
|
|
361
364
|
|
|
362
|
-
### analysis (
|
|
365
|
+
### analysis (108)
|
|
366
|
+
|
|
367
|
+
|
|
368
|
+
Metadata Capabilities (47):
|
|
369
|
+
|
|
370
|
+
- `asset abnormal-get` ([doc](references/asset_abnormal_get.md))
|
|
371
|
+
- `asset abnormal-list` ([doc](references/asset_abnormal_list.md))
|
|
372
|
+
- `asset authentication-list` ([doc](references/asset_authentication_list.md))
|
|
373
|
+
- `asset authentication-update` ([doc](references/asset_authentication_update.md))
|
|
374
|
+
- `asset recent-list` ([doc](references/asset_recent_list.md))
|
|
375
|
+
- `asset search` ([doc](references/asset_search.md))
|
|
376
|
+
- `datatable columns-get` ([doc](references/datatable_columns_get.md))
|
|
377
|
+
- `datatable influence-list` ([doc](references/datatable_influence_list.md))
|
|
378
|
+
- `datatable version-get` ([doc](references/datatable_version_get.md))
|
|
379
|
+
- `datatable version-list` ([doc](references/datatable_version_list.md))
|
|
380
|
+
- `event changelog-list` ([doc](references/event_changelog_list.md))
|
|
381
|
+
- `event create` ([doc](references/event_create.md))
|
|
382
|
+
- `event delete` ([doc](references/event_delete.md))
|
|
383
|
+
- `event get` ([doc](references/event_get.md))
|
|
384
|
+
- `event hide-update` ([doc](references/event_hide_update.md))
|
|
385
|
+
- `event influence-list` ([doc](references/event_influence_list.md))
|
|
386
|
+
- `event list` ([doc](references/event_list.md))
|
|
387
|
+
- `event relation-update` ([doc](references/event_relation_update.md))
|
|
388
|
+
- `event update` ([doc](references/event_update.md))
|
|
389
|
+
- `exchange config-update` ([doc](references/exchange_config_update.md))
|
|
390
|
+
- `exchange rate-refresh` ([doc](references/exchange_rate_refresh.md))
|
|
391
|
+
- `exchange rule-list` ([doc](references/exchange_rule_list.md))
|
|
392
|
+
- `exchange rule-update` ([doc](references/exchange_rule_update.md))
|
|
393
|
+
- `exchange rule-validate` ([doc](references/exchange_rule_validate.md))
|
|
394
|
+
- `metric create` ([doc](references/metric_create.md))
|
|
395
|
+
- `metric delete` ([doc](references/metric_delete.md))
|
|
396
|
+
- `metric get` ([doc](references/metric_get.md))
|
|
397
|
+
- `metric list` ([doc](references/metric_list.md))
|
|
398
|
+
- `metric update` ([doc](references/metric_update.md))
|
|
399
|
+
- `property changelog-list` ([doc](references/property_changelog_list.md))
|
|
400
|
+
- `property create` ([doc](references/property_create.md))
|
|
401
|
+
- `property delete` ([doc](references/property_delete.md))
|
|
402
|
+
- `property get` ([doc](references/property_get.md))
|
|
403
|
+
- `property hide-update` ([doc](references/property_hide_update.md))
|
|
404
|
+
- `property influence-list` ([doc](references/property_influence_list.md))
|
|
405
|
+
- `property list` ([doc](references/property_list.md))
|
|
406
|
+
- `property related-events` ([doc](references/property_related_events.md))
|
|
407
|
+
- `property relation-update` ([doc](references/property_relation_update.md))
|
|
408
|
+
- `property update` ([doc](references/property_update.md))
|
|
409
|
+
- `super-metadata export` ([doc](references/super_metadata_export.md))
|
|
410
|
+
- `super-metadata import` ([doc](references/super_metadata_import.md))
|
|
411
|
+
- `virtual-event create` ([doc](references/virtual_event_create.md))
|
|
412
|
+
- `virtual-event delete` ([doc](references/virtual_event_delete.md))
|
|
413
|
+
- `virtual-event get` ([doc](references/virtual_event_get.md))
|
|
414
|
+
- `virtual-property create` ([doc](references/virtual_property_create.md))
|
|
415
|
+
- `virtual-property sql-rule-delete` ([doc](references/virtual_property_sql_rule_delete.md))
|
|
416
|
+
- `virtual-property sql-rule-update` ([doc](references/virtual_property_sql_rule_update.md))
|
|
363
417
|
|
|
364
418
|
Alerts (6):
|
|
365
419
|
- `+get_alert_definition_schema` ([doc](references/get_alert_definition_schema.md))
|
|
@@ -377,7 +431,7 @@ Reports:
|
|
|
377
431
|
- `+update_report` ([doc](references/update_report.md))
|
|
378
432
|
- `+delete_report` ([doc](references/delete_report.md))
|
|
379
433
|
|
|
380
|
-
Dashboard, BI panel, project-space, folder, favorite, public-link, dashboard-definition, dashboard-daily-report, and dashboard/BI data commands are capability-gateway commands. Use `ae-cli analysis <resource> <action>` after reading [`references/analysis_gateway_assets.md`](references/analysis_gateway_assets.md); do not use old `+` dashboard/space/BI/public-link command names.
|
|
434
|
+
Dashboard, BI panel, project-space, folder, favorite, public-link, dashboard-definition, dashboard-daily-report, run, artifact, and dashboard/BI data commands are capability-gateway commands. Use `ae-cli analysis <resource> <action>` after reading [`references/analysis_gateway_assets.md`](references/analysis_gateway_assets.md); do not use old `+` dashboard/space/BI/public-link command names.
|
|
381
435
|
|
|
382
436
|
Model Analysis (17):
|
|
383
437
|
- `+build_event_analysis_qp` ([doc](references/build_event_analysis_qp.md))
|
|
@@ -496,4 +550,4 @@ npm run verify:analysis-common-tools
|
|
|
496
550
|
|
|
497
551
|
## Reference Docs
|
|
498
552
|
|
|
499
|
-
See the unified `references/` directory (
|
|
553
|
+
See the unified `references/` directory (126 command docs total).
|
|
@@ -14,19 +14,21 @@ This file is an overview only. Before running one command, read the dedicated co
|
|
|
14
14
|
|
|
15
15
|
## When to use
|
|
16
16
|
|
|
17
|
-
Use these commands for dashboard, BI panel, project-space, folder, favorite, public-link, dashboard-definition, dashboard-daily-report, and dashboard/BI page data workflows.
|
|
17
|
+
Use these commands for dashboard, BI panel, BI panel version, project-space, folder, favorite, public-link, dashboard-definition, dashboard-daily-report, and dashboard/BI page data workflows.
|
|
18
18
|
|
|
19
19
|
Prefer export commands for long-running or large data:
|
|
20
20
|
|
|
21
21
|
```bash
|
|
22
22
|
ae-cli analysis dashboard-report-data export --project-id 1 --dashboard-id 1001
|
|
23
|
+
ae-cli analysis run inspect --run-id run_0123456789abcdef0123456789abcdef
|
|
24
|
+
ae-cli analysis artifact download --run-id run_0123456789abcdef0123456789abcdef --artifact-id artifact_0123456789abcdef0123456789abcdef --output /tmp/dashboard.jsonl.gz
|
|
23
25
|
ae-cli analysis bi-panel-page-data export --project-id 1 --panel-id 2001 --page-key main --result-type charts
|
|
24
26
|
ae-cli analysis query cancel --run-id run_0123456789abcdef0123456789abcdef
|
|
25
27
|
```
|
|
26
28
|
|
|
27
29
|
## When not to use
|
|
28
30
|
|
|
29
|
-
Do not use these commands for ad-hoc model analysis, report definition, report data, drilldown, schema helpers, alerts, audience clusters/tags, project lookup, metadata governance, dashboard locks, BI panel
|
|
31
|
+
Do not use these commands for ad-hoc model analysis, report definition, report data, drilldown, schema helpers, alerts, audience clusters/tags, project lookup, metadata governance, dashboard locks, BI panel lock, dashboard filters, UI reorder/tree/move operations, daily report retry/download/get-config, or public-link logs/source-list/get. Use the existing `+<tool_name>` references for those.
|
|
30
32
|
|
|
31
33
|
## Output
|
|
32
34
|
|
|
@@ -52,7 +54,17 @@ Failures return:
|
|
|
52
54
|
}
|
|
53
55
|
```
|
|
54
56
|
|
|
55
|
-
Export commands return `run_id`, `artifact_id`, `status`, `artifact_status`, `
|
|
57
|
+
Export commands return `run_id`, `artifact_id`, `status`, `artifact_status`, `expires_at`, and `expires_at_iso`. They do not expose raw inspect/download API paths.
|
|
58
|
+
|
|
59
|
+
Artifact workflow:
|
|
60
|
+
|
|
61
|
+
1. Submit an export command and keep `data.run_id` and `data.artifact_id`.
|
|
62
|
+
2. Poll `ae-cli analysis run inspect --run-id <run_id>` every few seconds until `data.status` is terminal and `data.artifact_status` is complete.
|
|
63
|
+
3. Terminal success is `COMPLETED` or `SUCCEEDED`; terminal failure is `FAILED`, `CANCELED`, or `CANCELLED`. On failure, report the returned error fields instead of downloading.
|
|
64
|
+
4. Download with `ae-cli analysis artifact download --run-id <run_id> --artifact-id <artifact_id> --output <file>`.
|
|
65
|
+
5. Cancel long or abandoned exports with `ae-cli analysis query cancel --run-id <run_id>`.
|
|
66
|
+
|
|
67
|
+
Prefer the run/artifact commands over hand-written HTTP, Python, or curl. The descriptor paths are informational and may be internal `/api/cli/v1/...` paths behind a domain-routed CLI host.
|
|
56
68
|
|
|
57
69
|
## Command matrix
|
|
58
70
|
|
|
@@ -66,29 +78,33 @@ Export commands return `run_id`, `artifact_id`, `status`, `artifact_status`, `in
|
|
|
66
78
|
| `dashboard share` | `analysis.dashboard.share` | Modify dashboard sharing | `--project-id`, `--dashboard-id`, `--payload` or `--member-authorities` | Share update result |
|
|
67
79
|
| `dashboard delete` | `analysis.dashboard.delete` | Delete dashboards | `--project-id`, `--dashboard-ids '[...]'` | Delete result |
|
|
68
80
|
| `dashboard handover` | `analysis.dashboard.handover` | Transfer dashboards | `--dashboard-ids`, `--to-user-id` | Handover result |
|
|
69
|
-
| `dashboard copy` | `analysis.dashboard.copy` | Copy a dashboard | `--dashboard-id`, `--dashboard-name`, optional target IDs | Copied dashboard |
|
|
81
|
+
| `dashboard copy` | `analysis.dashboard.copy` | Copy a dashboard; omitted target IDs copy to the source location | `--dashboard-id`, `--dashboard-name`, optional target IDs | Copied dashboard |
|
|
70
82
|
| `dashboard freeze` | `analysis.dashboard.freeze` | Freeze/unfreeze dashboards | `--dashboard-ids`, optional `--freeze false` | Freeze status |
|
|
71
83
|
| `dashboard abnormal-get` | `analysis.dashboard.abnormal_get` | Inspect abnormal dependencies | `--dashboard-id` | Abnormal info |
|
|
72
84
|
| `dashboard task-status` | `analysis.dashboard.task_status` | Inspect scheduled task status | `--dashboard-id` | Task status |
|
|
73
|
-
| `dashboard-report-data run` | `analysis.dashboard_report_data.run` | Bounded inline dashboard report data | `--dashboard-id`, optional `--report-ids`, `--start-time`, `--end-time`, `--limit` | Inline data |
|
|
85
|
+
| `dashboard-report-data run` | `analysis.dashboard_report_data.run` | Bounded inline dashboard report data; `--filters` is analysis Filter JSON from `+get_filter_schema` | `--dashboard-id`, optional `--report-ids`, `--filters`, `--start-time`, `--end-time`, `--limit` | Inline data |
|
|
74
86
|
| `dashboard-report-data export` | `analysis.dashboard_report_data.export` | Large/long dashboard report data | same as run, plus optional `--artifact-format jsonl` | Async artifact descriptor |
|
|
87
|
+
| `run inspect` | `analysis.run.inspect` | Poll async export status | `--run-id` | Run and artifact status |
|
|
88
|
+
| `artifact download` | `analysis.artifact.download` | Download run-bound export artifact | `--run-id`, `--artifact-id`, `--output` | Local output file info |
|
|
75
89
|
| `query cancel` | `analysis.query.cancel` | Cancel gateway run/export | `--run-id`, optional `--reason` | Cancellation result |
|
|
76
|
-
| `dashboard-definition export` | `analysis.dashboard_definition.export` | Export dashboard definition JSON | `--dashboard-folder-ids`, `--shared-spaces`, or `--payload` | Definition JSON |
|
|
90
|
+
| `dashboard-definition export` | `analysis.dashboard_definition.export` | Export dashboard definition JSON | `--dashboard-id`, `--dashboard-ids`, `--dashboard-folder-ids`, `--shared-spaces`, or `--payload` | Definition JSON |
|
|
77
91
|
| `dashboard-definition import` | `analysis.dashboard_definition.import` | Validate/import dashboard definition | `--definition`, optional `--validate-only true` | Validation or import result |
|
|
78
|
-
| `dashboard-daily-report update` | `analysis.dashboard_daily_report.update` | Update daily report config | `--dashboard-id`, optional config flags or `--payload` | Config result |
|
|
79
|
-
| `dashboard-daily-report send` | `analysis.dashboard_daily_report.send` | Send daily report immediately | `--dashboard-id`, optional `--payload` | Async send result |
|
|
92
|
+
| `dashboard-daily-report update` | `analysis.dashboard_daily_report.update` | Update daily report config; defaults are sent when `--payload` is absent | `--dashboard-id`, optional config flags or `--payload` | Config result |
|
|
93
|
+
| `dashboard-daily-report send` | `analysis.dashboard_daily_report.send` | Send daily report immediately; no config flags means use saved config, missing saved config fails | `--dashboard-id`, optional config flags or `--payload` | Async send result |
|
|
80
94
|
| `bi-panel list` | `analysis.bi_panel.list` | Find accessible BI panels | `--project-id`, optional list filters | Paginated BI panel summaries |
|
|
81
|
-
| `bi-panel get` | `analysis.bi_panel.get` | Inspect released BI panel page structure | `--panel-id`, optional `--fields` | Panel structure |
|
|
95
|
+
| `bi-panel get` | `analysis.bi_panel.get` | Inspect released BI panel page structure only | `--panel-id`, optional `--fields` | Panel structure |
|
|
82
96
|
| `bi-panel create` | `analysis.bi_panel.create` | Create a BI panel | optional `--panel-name`, `--payload` | Created panel |
|
|
83
97
|
| `bi-panel update` | `analysis.bi_panel.update` | Update BI panel content/metadata | optional `--payload` | Update result |
|
|
84
98
|
| `bi-panel delete` | `analysis.bi_panel.delete` | Delete BI panels | `--panel-ids '[...]'` | Delete result |
|
|
85
99
|
| `bi-panel share` | `analysis.bi_panel.share` | Modify BI panel sharing | `--panel-id`, `--payload` | Share update result |
|
|
86
100
|
| `bi-panel copy` | `analysis.bi_panel.copy` | Copy a BI panel | optional source/target flags and `--payload` | Copied panel |
|
|
101
|
+
| `bi-panel-version get` | `analysis.bi_panel_version.get` | Inspect BI panel released or draft version | `--panel-id` or `--panel-uuid`, optional `--version-type release|draft` | Version detail |
|
|
102
|
+
| `bi-panel-version publish` | `analysis.bi_panel_version.publish` | Publish current BI panel draft after source version matches | `--panel-id` or `--panel-uuid`, `--source-version` | Published version |
|
|
87
103
|
| `bi-panel-page-data run` | `analysis.bi_panel_page_data.run` | Bounded inline BI page data | `--panel-id`, `--page-key`, `--result-type charts|summary` | Inline page data |
|
|
88
104
|
| `bi-panel-page-data export` | `analysis.bi_panel_page_data.export` | Large/long BI page data | same as run, optional `--artifact-format jsonl` | Async artifact descriptor |
|
|
89
105
|
| `project-space list` | `analysis.project_space.list` | Find accessible project spaces | `--project-id`, optional list filters | Paginated project spaces |
|
|
90
106
|
| `project-space get` | `analysis.project_space.get` | Inspect one project space | `--project-id`, `--space-id` | Project space detail |
|
|
91
|
-
| `project-space create` | `analysis.project_space.create` | Create a project space | `--space-name` or `--payload` | Created space |
|
|
107
|
+
| `project-space create` | `analysis.project_space.create` | Create a project space; `avatar_type` defaults to 1 when omitted | `--space-name` or `--payload` | Created space |
|
|
92
108
|
| `project-space delete` | `analysis.project_space.delete` | Delete project spaces | `--space-id` or `--space-ids` | Delete result |
|
|
93
109
|
| `project-space share` | `analysis.project_space.share` | Modify project-space members | `--space-id`, `--payload` | Share update result |
|
|
94
110
|
| `project-space members` | `analysis.project_space.members` | Read project-space members | `--space-id` | Members |
|
|
@@ -109,6 +125,7 @@ Export commands return `run_id`, `artifact_id`, `status`, `artifact_status`, `in
|
|
|
109
125
|
```bash
|
|
110
126
|
ae-cli analysis dashboard list --project-id 1 --query retention --limit 20
|
|
111
127
|
ae-cli analysis dashboard update --project-id 1 --operation note-upsert --dashboard-id 1001 --note-title "Summary" --description "Weekly note" --yes
|
|
128
|
+
ae-cli analysis dashboard-definition export --project-id 1 --dashboard-id 1001 --export-file-name retention_dashboard
|
|
112
129
|
ae-cli analysis dashboard-definition import --project-id 1 --definition '{"dashboard_folders":[],"shared_spaces":[]}' --validate-only true
|
|
113
130
|
ae-cli analysis public-link create --project-id 1 --resource-type dashboard --resource-id 1001 --effective-at "2026-07-08 00:00:00" --expires-at "2026-08-08 00:00:00" --yes
|
|
114
131
|
```
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# analysis artifact download
|
|
2
|
+
|
|
3
|
+
Use after `run inspect` shows an export artifact is complete.
|
|
4
|
+
|
|
5
|
+
Do not use before the run reaches a successful terminal status. Use `run inspect` first.
|
|
6
|
+
|
|
7
|
+
Command:
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
ae-cli analysis artifact download --run-id <run_id> --artifact-id <artifact_id> --output <file>
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Input sends `run_id`, `artifact_id`, and local `output` path.
|
|
14
|
+
|
|
15
|
+
Output is the gateway download result written to the local `--output` path. The command returns JSON with `run_id`, `artifact_id`, `output_path`, `bytes`, and response content headers.
|
|
16
|
+
|
|
17
|
+
Do not paste large artifact content into chat. Inspect the local file or summarize only the needed rows.
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# analysis asset abnormal-get
|
|
2
|
+
|
|
3
|
+
Use when the user needs to get abnormal reason for one asset.
|
|
4
|
+
|
|
5
|
+
Do not use this command for unrelated analysis queries, ad-hoc query construction, or MCP metadata discovery when an existing specialized command already fits the user's request.
|
|
6
|
+
|
|
7
|
+
Command:
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
ae-cli analysis asset abnormal-get --project-id <project_id> --resource-type <resource_type> --resource-id <resource_id> --resource-name <resource_name> --table-type <table_type>
|
|
11
|
+
ae-cli analysis asset abnormal-get --dry-run
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
Capability id: `metadata.asset_abnormal.get`.
|
|
15
|
+
|
|
16
|
+
Input sends `project_id`, `resource_type`, `resource_id`, `resource_name`, `table_type`.
|
|
17
|
+
|
|
18
|
+
Output is the gateway envelope. `data` contains the common-service capability result.
|
|
19
|
+
|
|
20
|
+
## Parameters
|
|
21
|
+
| Parameter | Required | Description |
|
|
22
|
+
|---|---|---|
|
|
23
|
+
| `--project-id` | Yes | Numeric project ID. |
|
|
24
|
+
| `--resource-type` | Yes | Resource type. |
|
|
25
|
+
| `--resource-id` | No | Resource ID. |
|
|
26
|
+
| `--resource-name` | No | Resource name. |
|
|
27
|
+
| `--table-type` | No | Property table type when the resource is a property. |
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# analysis asset abnormal-list
|
|
2
|
+
|
|
3
|
+
Use when the user needs to list abnormal assets by resource type.
|
|
4
|
+
|
|
5
|
+
Do not use this command for unrelated analysis queries, ad-hoc query construction, or MCP metadata discovery when an existing specialized command already fits the user's request.
|
|
6
|
+
|
|
7
|
+
Command:
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
ae-cli analysis asset abnormal-list --project-id <project_id> --resource-types <resource_types>
|
|
11
|
+
ae-cli analysis asset abnormal-list --dry-run
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
Capability id: `metadata.asset_abnormal.list`.
|
|
15
|
+
|
|
16
|
+
Input sends `project_id`, `resource_types`.
|
|
17
|
+
|
|
18
|
+
Output is the gateway envelope. `data` contains the common-service capability result.
|
|
19
|
+
|
|
20
|
+
## Parameters
|
|
21
|
+
| Parameter | Required | Description |
|
|
22
|
+
|---|---|---|
|
|
23
|
+
| `--project-id` | Yes | Numeric project ID. |
|
|
24
|
+
| `--resource-types` | Yes | Resource types to query. |
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# analysis asset authentication-list
|
|
2
|
+
|
|
3
|
+
Use when the user needs to list authenticatable project assets and authentication status.
|
|
4
|
+
|
|
5
|
+
Do not use this command for unrelated analysis queries, ad-hoc query construction, or MCP metadata discovery when an existing specialized command already fits the user's request.
|
|
6
|
+
|
|
7
|
+
Command:
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
ae-cli analysis asset authentication-list --project-id <project_id>
|
|
11
|
+
ae-cli analysis asset authentication-list --dry-run
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
Capability id: `metadata.asset_authentication.list`.
|
|
15
|
+
|
|
16
|
+
Input sends `project_id`.
|
|
17
|
+
|
|
18
|
+
Output is the gateway envelope. `data` contains the common-service capability result.
|
|
19
|
+
|
|
20
|
+
## Parameters
|
|
21
|
+
| Parameter | Required | Description |
|
|
22
|
+
|---|---|---|
|
|
23
|
+
| `--project-id` | Yes | Numeric project ID. |
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# analysis asset authentication-update
|
|
2
|
+
|
|
3
|
+
Use when the user needs to batch authenticate or unauthenticate assets.
|
|
4
|
+
|
|
5
|
+
Do not use this command for unrelated analysis queries, ad-hoc query construction, or MCP metadata discovery when an existing specialized command already fits the user's request.
|
|
6
|
+
|
|
7
|
+
Command:
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
ae-cli analysis asset authentication-update --project-id <project_id> --payload '{}'
|
|
11
|
+
ae-cli analysis asset authentication-update --dry-run
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
Capability id: `metadata.asset_authentication.update`.
|
|
15
|
+
|
|
16
|
+
Input sends `project_id`, `payload`.
|
|
17
|
+
|
|
18
|
+
Output is the gateway envelope. `data` contains the common-service capability result.
|
|
19
|
+
|
|
20
|
+
## Parameters
|
|
21
|
+
| Parameter | Required | Description |
|
|
22
|
+
|---|---|---|
|
|
23
|
+
| `--project-id` | Yes | Numeric project ID. |
|
|
24
|
+
| `--payload` | Yes | Capability payload JSON. |
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# analysis asset recent-list
|
|
2
|
+
|
|
3
|
+
Use when the user needs to list recently visited assets for the current user.
|
|
4
|
+
|
|
5
|
+
Do not use this command for unrelated analysis queries, ad-hoc query construction, or MCP metadata discovery when an existing specialized command already fits the user's request.
|
|
6
|
+
|
|
7
|
+
Command:
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
ae-cli analysis asset recent-list --project-id <project_id> --payload '{}'
|
|
11
|
+
ae-cli analysis asset recent-list --dry-run
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
Capability id: `metadata.asset.recent_list`.
|
|
15
|
+
|
|
16
|
+
Input sends `project_id`, `payload`.
|
|
17
|
+
|
|
18
|
+
Output is the gateway envelope. `data` contains the common-service capability result.
|
|
19
|
+
|
|
20
|
+
## Parameters
|
|
21
|
+
| Parameter | Required | Description |
|
|
22
|
+
|---|---|---|
|
|
23
|
+
| `--project-id` | Yes | Numeric project ID. |
|
|
24
|
+
| `--payload` | Yes | Capability payload JSON. |
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# analysis asset search
|
|
2
|
+
|
|
3
|
+
Use when the user needs to search project assets by keyword.
|
|
4
|
+
|
|
5
|
+
Do not use this command for unrelated analysis queries, ad-hoc query construction, or MCP metadata discovery when an existing specialized command already fits the user's request.
|
|
6
|
+
|
|
7
|
+
Command:
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
ae-cli analysis asset search --project-id <project_id> --payload '{}'
|
|
11
|
+
ae-cli analysis asset search --dry-run
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
Capability id: `metadata.asset.search`.
|
|
15
|
+
|
|
16
|
+
Input sends `project_id`, `payload`.
|
|
17
|
+
|
|
18
|
+
Output is the gateway envelope. `data` contains the common-service capability result.
|
|
19
|
+
|
|
20
|
+
## Parameters
|
|
21
|
+
| Parameter | Required | Description |
|
|
22
|
+
|---|---|---|
|
|
23
|
+
| `--project-id` | Yes | Numeric project ID. |
|
|
24
|
+
| `--payload` | Yes | Capability payload JSON. |
|
|
@@ -2,6 +2,11 @@
|
|
|
2
2
|
|
|
3
3
|
Use when the user needs one BI panel's released page structure.
|
|
4
4
|
|
|
5
|
+
This command reads only the released/queryable structure. It can fail with
|
|
6
|
+
`NOT_FOUND` for a newly created or draft-only panel. To inspect unpublished
|
|
7
|
+
edits, use `bi-panel-version get --version-type draft`. To make draft edits
|
|
8
|
+
queryable, publish them with `bi-panel-version publish`.
|
|
9
|
+
|
|
5
10
|
Do not use to query chart data. Use `bi-panel-page-data run` or `bi-panel-page-data export`.
|
|
6
11
|
|
|
7
12
|
Command:
|
|
@@ -12,4 +12,14 @@ ae-cli analysis bi-panel-page-data export --project-id <project_id> --panel-id <
|
|
|
12
12
|
|
|
13
13
|
Input sends `project_id`, `panel_id`, `page_key`, `result_type`, and optional control, paging, cache, request, timeout, and format fields. Use CLI flag `--artifact-format` for the gateway `format` input; `--format` is the CLI output formatter.
|
|
14
14
|
|
|
15
|
-
Output is the gateway envelope. `data` contains an async export descriptor
|
|
15
|
+
Output is the gateway envelope. `data` contains an async export descriptor with `run_id`, `artifact_id`, status fields, and expiration fields. It does not expose inspect/download API paths; use the CLI commands below.
|
|
16
|
+
|
|
17
|
+
Follow-up workflow:
|
|
18
|
+
|
|
19
|
+
1. Save `data.run_id` and `data.artifact_id` from the export response.
|
|
20
|
+
2. Poll status with `ae-cli analysis run inspect --run-id <run_id>`.
|
|
21
|
+
3. Continue polling while status is running or pending. Treat `COMPLETED` or `SUCCEEDED` as success, and `FAILED`, `CANCELED`, or `CANCELLED` as terminal failure.
|
|
22
|
+
4. On success, download with `ae-cli analysis artifact download --run-id <run_id> --artifact-id <artifact_id> --output <file>`.
|
|
23
|
+
5. If the export is no longer needed, cancel with `ae-cli analysis query cancel --run-id <run_id> --yes`.
|
|
24
|
+
|
|
25
|
+
Do not write custom Python/curl for polling or download unless the CLI command itself is unavailable.
|
|
@@ -12,4 +12,10 @@ ae-cli analysis bi-panel share --project-id <project_id> --panel-id <panel_id> [
|
|
|
12
12
|
|
|
13
13
|
Input sends `project_id`, `panel_id`, and backend-compatible snake_case `payload`.
|
|
14
14
|
|
|
15
|
+
Supported payload fields include:
|
|
16
|
+
|
|
17
|
+
- `all_auth_user_authority`: project-wide BI panel authority. Use `READ`, `JUNIOR`, `SENIOR`, or `MAINTAIN`; `VIEWER` is accepted as `READ`.
|
|
18
|
+
- `auth_users`: user authority list.
|
|
19
|
+
- `auth_user_groups`: user-group authority list.
|
|
20
|
+
|
|
15
21
|
Output is the gateway envelope. `data` contains the share update result.
|
|
@@ -2,7 +2,10 @@
|
|
|
2
2
|
|
|
3
3
|
Use when the user wants to update BI panel content or metadata.
|
|
4
4
|
|
|
5
|
-
Do not use
|
|
5
|
+
Do not use this command to verify draft content or publish a draft. `bi-panel get`
|
|
6
|
+
reads only the released/queryable version. Use `bi-panel-version get` to inspect
|
|
7
|
+
`release` or `draft`, and `bi-panel-version publish` to publish a matching draft
|
|
8
|
+
`source_version`.
|
|
6
9
|
|
|
7
10
|
Command:
|
|
8
11
|
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# analysis bi-panel-version get
|
|
2
|
+
|
|
3
|
+
Use when the user needs a BI panel's released version or unpublished draft version.
|
|
4
|
+
|
|
5
|
+
Do not use `bi-panel get` for draft verification; `bi-panel get` reads only the
|
|
6
|
+
released/queryable structure.
|
|
7
|
+
|
|
8
|
+
Command:
|
|
9
|
+
|
|
10
|
+
```bash
|
|
11
|
+
ae-cli analysis bi-panel-version get --project-id <project_id> --panel-id <panel_id> --version-type draft
|
|
12
|
+
ae-cli analysis bi-panel-version get --project-id <project_id> --panel-uuid <panel_uuid> --version-type release
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
Input sends `project_id`, one of `panel_id` or `panel_uuid`, optional
|
|
16
|
+
`version_type` (`release` by default), and optional `fields`.
|
|
17
|
+
|
|
18
|
+
Output is the gateway envelope. `data` contains `panel_id`, `panel_uuid`,
|
|
19
|
+
`requested_version_type`, `version_type`, `version`, `page_content`,
|
|
20
|
+
`panel_config`, and `worksheet_map`.
|
|
21
|
+
|
|
22
|
+
When the result is used before publishing, save `data.version` and pass it as
|
|
23
|
+
`--source-version` to `bi-panel-version publish`.
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# analysis bi-panel-version publish
|
|
2
|
+
|
|
3
|
+
Use when the user wants to publish the current BI panel draft so `bi-panel get`
|
|
4
|
+
and BI page-data queries can read it as a released/queryable version.
|
|
5
|
+
|
|
6
|
+
Do not use this command blindly after `bi-panel update`. First inspect the draft with
|
|
7
|
+
`bi-panel-version get --version-type draft` and use the returned `data.version`
|
|
8
|
+
as `--source-version`. The gateway rejects stale `source_version` values.
|
|
9
|
+
|
|
10
|
+
Command:
|
|
11
|
+
|
|
12
|
+
```bash
|
|
13
|
+
ae-cli analysis bi-panel-version publish --project-id <project_id> --panel-id <panel_id> --source-version <draft_version> --yes
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
Input sends `project_id`, one of `panel_id` or `panel_uuid`, and required
|
|
17
|
+
`source_version`.
|
|
18
|
+
|
|
19
|
+
Output is the gateway envelope. `data` contains `panel_id`, `panel_uuid`,
|
|
20
|
+
`source_version_type`, `source_version`, and `published_version`.
|
|
@@ -4,12 +4,14 @@ Use when the user wants to copy a dashboard, optionally copying reports and targ
|
|
|
4
4
|
|
|
5
5
|
Do not use to create a blank dashboard. Use `dashboard create`.
|
|
6
6
|
|
|
7
|
+
If both `--to-space-id` and `--to-folder-id` are omitted, the gateway copies to the source dashboard's current location. Do not manually discover a target folder just to copy in place.
|
|
8
|
+
|
|
7
9
|
Command:
|
|
8
10
|
|
|
9
11
|
```bash
|
|
10
12
|
ae-cli analysis dashboard copy --project-id <project_id> --dashboard-id <source_dashboard_id> --dashboard-name <new_name> [--report-copy true] [--to-space-id <space_id>] [--to-folder-id <folder_id>] --yes
|
|
11
13
|
```
|
|
12
14
|
|
|
13
|
-
Input sends `project_id`, `dashboard_id`, `dashboard_name`, and optional `
|
|
15
|
+
Input sends `project_id`, `dashboard_id`, `dashboard_name`, `report_copy` defaulting to false, and optional `to_space_id`, `to_folder_id`.
|
|
14
16
|
|
|
15
17
|
Output is the gateway envelope. `data` contains the copied dashboard result.
|
|
@@ -7,9 +7,16 @@ Do not use for configuration changes. Use `dashboard-daily-report update`.
|
|
|
7
7
|
Command:
|
|
8
8
|
|
|
9
9
|
```bash
|
|
10
|
-
ae-cli analysis dashboard-daily-report send --project-id <project_id> --dashboard-id <dashboard_id> [--need-csv
|
|
10
|
+
ae-cli analysis dashboard-daily-report send --project-id <project_id> --dashboard-id <dashboard_id> [--need-csv true] [--host-url <url>] [--payload '{...}'] --yes
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Input sends `project_id`, `dashboard_id`, and optional
|
|
13
|
+
Input sends `project_id`, `dashboard_id`, and optional daily report fields or `payload`.
|
|
14
|
+
|
|
15
|
+
Behavior:
|
|
16
|
+
|
|
17
|
+
- If no daily report config flags and no `--payload` are provided, the gateway uses the dashboard's saved daily report config.
|
|
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
|
+
- 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
|
+
- Use `dashboard-daily-report update` to save or change scheduled daily report config.
|
|
14
21
|
|
|
15
22
|
Output is the gateway envelope. `data` contains the immediate send result.
|
|
@@ -7,9 +7,11 @@ Do not use to send immediately. Use `dashboard-daily-report send`.
|
|
|
7
7
|
Command:
|
|
8
8
|
|
|
9
9
|
```bash
|
|
10
|
-
ae-cli analysis dashboard-daily-report update --project-id <project_id> --dashboard-id <dashboard_id> [--enable-send
|
|
10
|
+
ae-cli analysis dashboard-daily-report update --project-id <project_id> --dashboard-id <dashboard_id> [--enable-send true] [--send-time <time>] [--send-title <title>] [--send-content <content>] [--payload '{...}'] --yes
|
|
11
11
|
```
|
|
12
12
|
|
|
13
13
|
Input sends `project_id`, `dashboard_id`, and optional daily report fields or `payload`.
|
|
14
14
|
|
|
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
|
+
|
|
15
17
|
Output is the gateway envelope. `data` contains the daily report configuration update result.
|
|
@@ -1,15 +1,33 @@
|
|
|
1
1
|
# analysis dashboard-definition export
|
|
2
2
|
|
|
3
|
-
Use when the user wants to export dashboard definition JSON for selected dashboard folders or shared spaces.
|
|
3
|
+
Use when the user wants to export dashboard definition JSON for one dashboard, multiple dashboards, selected private dashboard folders, or shared project spaces.
|
|
4
4
|
|
|
5
5
|
Do not use for dashboard report result data. Use `dashboard-report-data run` or `dashboard-report-data export`.
|
|
6
6
|
|
|
7
7
|
Command:
|
|
8
8
|
|
|
9
9
|
```bash
|
|
10
|
-
ae-cli analysis dashboard-definition export --project-id <project_id> [--dashboard-folder-ids '[...]'] [--shared-spaces '[...]'] [--export-file-name <name>] [--payload '{...}']
|
|
10
|
+
ae-cli analysis dashboard-definition export --project-id <project_id> [--dashboard-id <dashboard_id>] [--dashboard-ids '[1,2]'] [--dashboard-folder-ids '[...]'] [--shared-spaces '[...]'] [--export-file-name <name>] [--payload '{...}']
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Input sends `project_id` and optional `dashboard_folder_ids`, `shared_spaces`, `export_file_name`, `payload`.
|
|
13
|
+
Input sends `project_id` and optional `dashboard_id`, `dashboard_ids`, `dashboard_folder_ids`, `shared_spaces`, `export_file_name`, `payload`.
|
|
14
|
+
|
|
15
|
+
Prefer `--dashboard-id` or `--dashboard-ids` when the user asks for a single dashboard or a known dashboard list. The gateway resolves private-folder or project-space context.
|
|
16
|
+
|
|
17
|
+
For a private folder export, `--dashboard-folder-ids '[123]'` is accepted. Use the advanced descriptor form only when you need to restrict which dashboards inside the folder are exported.
|
|
18
|
+
|
|
19
|
+
Advanced private-folder descriptor form:
|
|
20
|
+
|
|
21
|
+
```bash
|
|
22
|
+
ae-cli analysis dashboard-definition export --project-id <project_id> \
|
|
23
|
+
--dashboard-folder-ids '[{"dashboard_folder_id":123,"dashboard_ids":[456]}]'
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
Advanced project-space descriptor form:
|
|
27
|
+
|
|
28
|
+
```bash
|
|
29
|
+
ae-cli analysis dashboard-definition export --project-id <project_id> \
|
|
30
|
+
--shared-spaces '[{"space_id":10,"children":[{"is_folder":false,"id":456}]}]'
|
|
31
|
+
```
|
|
14
32
|
|
|
15
33
|
Output is the gateway envelope. `data` contains exported definition data or an export descriptor.
|
|
@@ -12,4 +12,20 @@ ae-cli analysis dashboard-report-data export --project-id <project_id> --dashboa
|
|
|
12
12
|
|
|
13
13
|
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.
|
|
14
14
|
|
|
15
|
-
|
|
15
|
+
`--filters` is an analysis Filter JSON injected as `commonFilter.aiFilter` for each queried report. It is not a dashboard UI control dump. Use `ae-cli analysis +get_filter_schema` for the exact schema. Minimal shape:
|
|
16
|
+
|
|
17
|
+
```json
|
|
18
|
+
{"relation":"and","filts":[{"field":{"type":"event_property","propertyName":"#event_name"},"operator":"equal","values":["login"]}]}
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
Output is the gateway envelope. `data` contains an async export descriptor with `run_id`, `artifact_id`, status fields, and expiration fields. It does not expose inspect/download API paths; use the CLI commands below.
|
|
22
|
+
|
|
23
|
+
Follow-up workflow:
|
|
24
|
+
|
|
25
|
+
1. Save `data.run_id` and `data.artifact_id` from the export response.
|
|
26
|
+
2. Poll status with `ae-cli analysis run inspect --run-id <run_id>`.
|
|
27
|
+
3. Continue polling while status is running or pending. Treat `COMPLETED` or `SUCCEEDED` as success, and `FAILED`, `CANCELED`, or `CANCELLED` as terminal failure.
|
|
28
|
+
4. On success, download with `ae-cli analysis artifact download --run-id <run_id> --artifact-id <artifact_id> --output <file>`.
|
|
29
|
+
5. If the export is no longer needed, cancel with `ae-cli analysis query cancel --run-id <run_id> --yes`.
|
|
30
|
+
|
|
31
|
+
Do not write custom Python/curl for polling or download unless the CLI command itself is unavailable.
|
|
@@ -12,4 +12,10 @@ ae-cli analysis dashboard-report-data run --project-id <project_id> --dashboard-
|
|
|
12
12
|
|
|
13
13
|
Input sends `project_id`, `dashboard_id`, and optional `report_ids`, `filters`, `start_time`, `end_time`, `use_cache`, `request_id`, `timeout_seconds`, `limit`.
|
|
14
14
|
|
|
15
|
+
`--filters` is an analysis Filter JSON injected as `commonFilter.aiFilter` for each queried report. It is not a dashboard UI control dump. Use `ae-cli analysis +get_filter_schema` for the exact schema. Minimal shape:
|
|
16
|
+
|
|
17
|
+
```json
|
|
18
|
+
{"relation":"and","filts":[{"field":{"type":"event_property","propertyName":"#event_name"},"operator":"equal","values":["login"]}]}
|
|
19
|
+
```
|
|
20
|
+
|
|
15
21
|
Output is the gateway envelope. `data` contains bounded inline report data.
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# analysis datatable columns-get
|
|
2
|
+
|
|
3
|
+
Use when the user needs to get columns for a project table reference.
|
|
4
|
+
|
|
5
|
+
Do not use this command for unrelated analysis queries, ad-hoc query construction, or MCP metadata discovery when an existing specialized command already fits the user's request.
|
|
6
|
+
|
|
7
|
+
Command:
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
ae-cli analysis datatable columns-get --project-id <project_id> --table-ref <table_ref>
|
|
11
|
+
ae-cli analysis datatable columns-get --dry-run
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
Capability id: `metadata.data_table.columns_get`.
|
|
15
|
+
|
|
16
|
+
Input sends `project_id`, `table_ref`.
|
|
17
|
+
|
|
18
|
+
Output is the gateway envelope. `data` contains the common-service capability result.
|
|
19
|
+
|
|
20
|
+
## Parameters
|
|
21
|
+
| Parameter | Required | Description |
|
|
22
|
+
|---|---|---|
|
|
23
|
+
| `--project-id` | Yes | Numeric project ID. |
|
|
24
|
+
| `--table-ref` | Yes | Project table reference. |
|