@thinkingai/ae-cli 6.0.22 → 6.0.24
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-RDN6D5HU.js → auth-A2XXG5K4.js} +7 -11
- package/dist/auth-IDPKDFSY.js +13 -0
- package/dist/{chunk-4EUZRJPO.js → chunk-2OW2RENH.js} +40 -10
- package/dist/{chunk-H52CSLJW.js → chunk-4FQ36OGO.js} +4 -4
- package/dist/chunk-AKORWVHJ.js +59 -0
- package/dist/{chunk-E34XH4GW.js → chunk-F3ZDMC2W.js} +8 -8
- package/dist/chunk-FIT4CFIN.js +59 -0
- package/dist/{chunk-2W7HULUD.js → chunk-IDXW6MEJ.js} +2 -2
- package/dist/{chunk-5FBLRSMU.js → chunk-NGJDCOYA.js} +3 -3
- package/dist/chunk-NXJP4CES.js +209 -0
- package/dist/{chunk-FPE5LGVU.js → chunk-OCQPQYHZ.js} +2 -2
- package/dist/{chunk-YACCPUNQ.js → chunk-ONOA6DYB.js} +1 -1
- package/dist/{chunk-U6QPKCN3.js → chunk-PFJFZVCK.js} +8 -115
- package/dist/chunk-V5R5UIRM.js +195 -0
- package/dist/{chunk-XE2PI5DS.js → chunk-WXBCP6SD.js} +1 -1
- package/dist/{cli-token-6AGEDJF4.js → cli-token-OZXHC3U2.js} +3 -3
- package/dist/{client-VTJMUZ4O.js → client-7L735LVY.js} +3 -3
- package/dist/{config-2SDTLGOC.js → config-SXD2JKSL.js} +3 -3
- package/dist/index.js +27 -24
- package/dist/{metadata-JZ2OTWBK.js → metadata-QWUAX625.js} +56 -65
- package/dist/metadata-XWTEGEN2.js +411 -0
- package/dist/{model-ZYMRN4VS.js → model-3OVX42DA.js} +2 -2
- package/dist/{raw-NGYHAL3F.js → raw-IANB4AV5.js} +4 -4
- package/dist/{sync-JVLX6TGW.js → sync-4HQ3CXSK.js} +3 -3
- package/dist/{te-agent-QPZTLHPH.js → te-agent-OYNNTJDU.js} +2 -2
- package/dist/{te-analysis-WWX3Z6RP.js → te-analysis-CRPFK3LX.js} +1074 -340
- package/dist/te-analysis-JX3V76OI.js +2281 -0
- package/dist/{te-audience-UXGHUVBB.js → te-audience-77FGNG5E.js} +5 -5
- package/dist/te-audience-RO2IZOUC.js +599 -0
- package/dist/{te-common-7XXH73MF.js → te-common-4TRJPRC5.js} +5 -5
- package/dist/te-common-PUXBUPOL.js +130 -0
- package/dist/{te-community-QKE67HR2.js → te-community-NPDZQKMY.js} +5 -5
- package/dist/te-community-XKE526DS.js +687 -0
- package/dist/{te-dataops-6W7NNYST.js → te-dataops-6KWLFNV4.js} +5 -5
- package/dist/te-dataops-PW74WP76.js +1842 -0
- package/dist/{te-engage-NCFAQFX3.js → te-engage-HTLMUN7G.js} +5 -5
- package/dist/te-engage-YPQIVF5H.js +1510 -0
- package/dist/{te-kb-K5BQYUCM.js → te-kb-DOGDQIU4.js} +4 -4
- package/dist/{te-meta-LJZBOSMO.js → te-meta-5ESSQ5B3.js} +5 -5
- package/dist/te-meta-Z47X4VT3.js +595 -0
- package/dist/{te-team-DHK5R7MV.js → te-team-SOVKZIDD.js} +5 -5
- package/package.json +1 -1
- package/skills/ae-analysis/SKILL.md +51 -25
- package/skills/ae-analysis/references/analysis_gateway_assets.md +114 -0
- package/skills/ae-analysis/references/bi_panel_copy.md +15 -0
- package/skills/ae-analysis/references/bi_panel_create.md +15 -0
- package/skills/ae-analysis/references/bi_panel_delete.md +15 -0
- package/skills/ae-analysis/references/bi_panel_get.md +18 -0
- package/skills/ae-analysis/references/bi_panel_list.md +15 -0
- package/skills/ae-analysis/references/bi_panel_page_data_export.md +15 -0
- package/skills/ae-analysis/references/bi_panel_page_data_run.md +15 -0
- package/skills/ae-analysis/references/bi_panel_share.md +15 -0
- package/skills/ae-analysis/references/bi_panel_update.md +15 -0
- package/skills/ae-analysis/references/dashboard_abnormal_get.md +15 -0
- package/skills/ae-analysis/references/dashboard_copy.md +15 -0
- package/skills/ae-analysis/references/dashboard_create.md +15 -0
- package/skills/ae-analysis/references/dashboard_daily_report_send.md +15 -0
- package/skills/ae-analysis/references/dashboard_daily_report_update.md +15 -0
- package/skills/ae-analysis/references/dashboard_definition_export.md +15 -0
- package/skills/ae-analysis/references/dashboard_definition_import.md +15 -0
- package/skills/ae-analysis/references/dashboard_delete.md +15 -0
- package/skills/ae-analysis/references/dashboard_freeze.md +15 -0
- package/skills/ae-analysis/references/dashboard_get.md +15 -0
- package/skills/ae-analysis/references/dashboard_handover.md +15 -0
- package/skills/ae-analysis/references/dashboard_list.md +15 -0
- package/skills/ae-analysis/references/dashboard_report_data_export.md +15 -0
- package/skills/ae-analysis/references/dashboard_report_data_run.md +15 -0
- package/skills/ae-analysis/references/dashboard_share.md +15 -0
- package/skills/ae-analysis/references/dashboard_share_info.md +15 -0
- package/skills/ae-analysis/references/dashboard_task_status.md +15 -0
- package/skills/ae-analysis/references/dashboard_update.md +16 -0
- package/skills/ae-analysis/references/favorite_add.md +15 -0
- package/skills/ae-analysis/references/favorite_remove.md +15 -0
- package/skills/ae-analysis/references/folder_create.md +15 -0
- package/skills/ae-analysis/references/folder_delete.md +15 -0
- package/skills/ae-analysis/references/folder_members.md +15 -0
- package/skills/ae-analysis/references/folder_share.md +15 -0
- package/skills/ae-analysis/references/project_space_create.md +15 -0
- package/skills/ae-analysis/references/project_space_delete.md +15 -0
- package/skills/ae-analysis/references/project_space_get.md +18 -0
- package/skills/ae-analysis/references/project_space_list.md +15 -0
- package/skills/ae-analysis/references/project_space_members.md +15 -0
- package/skills/ae-analysis/references/project_space_share.md +15 -0
- package/skills/ae-analysis/references/public_link_create.md +15 -0
- package/skills/ae-analysis/references/public_link_delete.md +15 -0
- package/skills/ae-analysis/references/public_link_list.md +15 -0
- package/skills/ae-analysis/references/public_link_offline.md +15 -0
- package/skills/ae-analysis/references/public_link_update.md +15 -0
- package/skills/ae-analysis/references/query_cancel.md +15 -0
- package/skills/ae-metadata/references/metadata_data_table_csv_write.md +5 -3
- package/skills/ae-metadata/references/metadata_data_table_sql_write.md +5 -4
- package/skills/ae-metadata/references/metadata_property_dimension_table_create_and_bind_csv.md +5 -3
- package/dist/auth-I2G7OAU2.js +0 -19
- package/dist/{chunk-WPXHCP4A.js → chunk-65DKFJZB.js} +3 -3
|
@@ -10,6 +10,7 @@ description: "AE/TE/ThinkingEngine/ThinkingAI ae-cli manual for analysis-side ta
|
|
|
10
10
|
> **CRITICAL - For all commands that require `project_id`, you MUST satisfy `PROJECT_ID_GATE` first (no guessing): verify the project by ID/name with `analysis_common +list_projects` only when there is no valid project context yet, when the user switches project/host/environment, or when the supplied project is ambiguous. Reuse a project already verified in the same continuous conversation and same host/environment.**
|
|
11
11
|
> **CRITICAL - For write operations in this skill, you MUST complete the post-write link loop when applicable:** after success and extractable `resource_id`, call `analysis_common +get_resource_url` and return the main result + resource link (or explicit link-failure reason).
|
|
12
12
|
> **CRITICAL - Before running any `+<tool_name>` command, you MUST first read the corresponding `references/<tool_name>.md`.** The reference filename always equals the command name without the leading `+`, for example `+query_adhoc` -> `references/query_adhoc.md`.
|
|
13
|
+
> **CRITICAL - Before running any capability-gateway asset command such as `ae-cli analysis dashboard list`, `ae-cli analysis bi-panel get`, `ae-cli analysis project-space create`, or `ae-cli analysis public-link list`, read the matching `references/<resource>_<action>.md` file. Replace hyphens with underscores, for example `analysis dashboard list` -> `references/dashboard_list.md`, `analysis bi-panel get` -> `references/bi_panel_get.md`. Use [`references/analysis_gateway_assets.md`](references/analysis_gateway_assets.md) only as the overview matrix.**
|
|
13
14
|
|
|
14
15
|
## Global AE CLI Rules
|
|
15
16
|
|
|
@@ -21,7 +22,7 @@ Global parameters:
|
|
|
21
22
|
| ------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
22
23
|
| `--format <json\|table>` | Output format. Default is JSON. |
|
|
23
24
|
| `--jq <expr>` | jq filter expression for JSON output. |
|
|
24
|
-
| `--host <url>` | Override the active AE host. Available on every command and may be placed after the subcommand, e.g. `ae-cli analysis
|
|
25
|
+
| `--host <url>` | Override the active AE host. Available on every command and may be placed after the subcommand, e.g. `ae-cli analysis dashboard list --host <url>`. |
|
|
25
26
|
|
|
26
27
|
Output and errors:
|
|
27
28
|
|
|
@@ -52,14 +53,55 @@ If user intent is Engage/DataOps/Community/metadata gateway detail, switch to `a
|
|
|
52
53
|
- `ae-cli analysis_audience +<tool_name> [options]`
|
|
53
54
|
- `ae-cli analysis_meta +<tool_name> [options]`
|
|
54
55
|
- `ae-cli analysis_common +<tool_name> [options]`
|
|
56
|
+
- `ae-cli analysis <resource> <action> [options]` for capability-gateway dashboard, BI panel, project-space, folder, favorite, public-link, dashboard-definition, dashboard-daily-report, and async asset data commands.
|
|
55
57
|
|
|
56
58
|
Conventions:
|
|
57
59
|
|
|
58
|
-
-
|
|
60
|
+
- MCP `+<tool_name>` command flags use underscores, e.g. `--project_id`.
|
|
61
|
+
- Capability-gateway command flags use kebab-case, e.g. `--project-id`, `--dashboard-id`, `--request-id`. The CLI sends snake_case JSON to the gateway.
|
|
59
62
|
- MCP params map automatically to camelCase.
|
|
60
63
|
- JSON args pass as JSON string literals.
|
|
61
64
|
- Write operations require confirmation unless `--yes`.
|
|
62
65
|
|
|
66
|
+
## Capability Gateway Asset Commands
|
|
67
|
+
|
|
68
|
+
Use these commands for dashboard, BI panel, project space, folder, favorite, public link, dashboard definition import/export, dashboard daily report, and dashboard/BI page data operations:
|
|
69
|
+
|
|
70
|
+
```bash
|
|
71
|
+
ae-cli analysis dashboard list --project-id <project_id>
|
|
72
|
+
ae-cli analysis dashboard get --project-id <project_id> --dashboard-id <dashboard_id>
|
|
73
|
+
ae-cli analysis dashboard update --project-id <project_id> --operation settings --dashboard-id <dashboard_id> --payload '{...}'
|
|
74
|
+
ae-cli analysis dashboard-report-data export --project-id <project_id> --dashboard-id <dashboard_id>
|
|
75
|
+
ae-cli analysis bi-panel-page-data run --project-id <project_id> --panel-id <panel_id> --page-key <page_key> --result-type charts
|
|
76
|
+
ae-cli analysis project-space list --project-id <project_id>
|
|
77
|
+
ae-cli analysis query cancel --run-id <run_id>
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
Use capability-gateway asset commands when the user wants to manage or inspect:
|
|
81
|
+
|
|
82
|
+
- Dashboards, dashboard basic detail including creator/create time, dashboard sharing, dashboard notes, dashboard copy/freeze/handover/delete, abnormal info, task status.
|
|
83
|
+
- 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
|
+
- 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
|
+
- 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.
|
|
87
|
+
- Project spaces, folders, favorites, and public links.
|
|
88
|
+
|
|
89
|
+
Do **not** use these commands for:
|
|
90
|
+
|
|
91
|
+
- 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 version/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
|
+
- Internal-only or UI-only payloads unless the gateway command reference explicitly exposes them through `--payload`.
|
|
94
|
+
|
|
95
|
+
Capability-gateway output:
|
|
96
|
+
|
|
97
|
+
- Successful commands return the standard gateway envelope: `{ "ok": true, "data": ..., "meta": ... }`.
|
|
98
|
+
- Failed commands return `{ "ok": false, "error": ... }` and exit non-zero.
|
|
99
|
+
- Inline `run` data is bounded by `--limit` and `--timeout-seconds`.
|
|
100
|
+
- Export commands return `run_id`, `artifact_id`, artifact status, inspect path, and download path. Use `--artifact-format jsonl` for the artifact format; `--format` is reserved for CLI output formatting. Cancel with `ae-cli analysis query cancel --run-id <run_id>`.
|
|
101
|
+
- Unknown input fields and camelCase external fields are rejected by the gateway; use kebab-case CLI flags only.
|
|
102
|
+
|
|
103
|
+
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`.
|
|
104
|
+
|
|
63
105
|
## Mandatory Constraints
|
|
64
106
|
|
|
65
107
|
### A. PROJECT_ID_GATE
|
|
@@ -78,7 +120,7 @@ For any command requiring `project_id`:
|
|
|
78
120
|
|
|
79
121
|
When these writes succeed and `resource_id` is extractable, call `analysis_common +get_resource_url` and append link output:
|
|
80
122
|
|
|
81
|
-
- `dashboard`:
|
|
123
|
+
- `dashboard`: `analysis dashboard create`, `analysis dashboard update`
|
|
82
124
|
- `report`: `+create_report`
|
|
83
125
|
- `metric`: `+create_metric`, `+update_metric`
|
|
84
126
|
- `alert`: `+create_alert`, `+update_alert`
|
|
@@ -97,7 +139,7 @@ Closed-loop check (must be explicit in result):
|
|
|
97
139
|
|
|
98
140
|
### C. FUZZY_SEARCH_FALLBACK
|
|
99
141
|
|
|
100
|
-
For list commands with `--query` parameter (list_reports
|
|
142
|
+
For list commands with `--query` parameter (`list_reports`, `analysis dashboard list`, `list_events`, `list_clusters`, `list_tags`, `list_alerts`, `list_metrics`):
|
|
101
143
|
|
|
102
144
|
1. **First attempt**: Use `--query` with user-provided keyword for fuzzy search
|
|
103
145
|
2. **If no results found**, retry up to 2 more times with:
|
|
@@ -123,8 +165,8 @@ Before executing ad-hoc queries (`query_adhoc`), MUST check for existing reports
|
|
|
123
165
|
|
|
124
166
|
1. **Identify user intent** - Extract what metrics/dimensions/filters the user wants
|
|
125
167
|
2. **Search existing reports** - Use `list_reports --query <keyword>` to find matching reports
|
|
126
|
-
3. **Search existing dashboards** - Use `
|
|
127
|
-
4. **If found** - Use `query_report_data` or `
|
|
168
|
+
3. **Search existing dashboards** - Use `analysis dashboard list --query <keyword>` to find matching dashboards
|
|
169
|
+
4. **If found** - Use `query_report_data` or `analysis dashboard-report-data run/export` to get data from existing assets
|
|
128
170
|
5. **If not found** - For QP builder-supported models (`event`, `retention`, `funnel`, `prop_analysis`), call the matching builder first and then call `query_adhoc` with builder `qp`; do not call schema or metadata tools between the report/dashboard miss and the builder. For all other `query_adhoc` models, use the legacy schema/metadata path.
|
|
129
171
|
|
|
130
172
|
**Rationale:**
|
|
@@ -327,31 +369,15 @@ Alerts (6):
|
|
|
327
369
|
- `+update_alert` ([doc](references/update_alert.md))
|
|
328
370
|
- `+delete_alert` ([doc](references/delete_alert.md))
|
|
329
371
|
|
|
330
|
-
Reports
|
|
372
|
+
Reports:
|
|
331
373
|
- `+create_report` ([doc](references/create_report.md))
|
|
332
374
|
- `+get_report_definition` ([doc](references/get_report_definition.md))
|
|
333
375
|
- `+list_reports` ([doc](references/list_reports.md))
|
|
334
376
|
- `+query_report_data` ([doc](references/query_report_data.md))
|
|
335
377
|
- `+update_report` ([doc](references/update_report.md))
|
|
336
378
|
- `+delete_report` ([doc](references/delete_report.md))
|
|
337
|
-
|
|
338
|
-
-
|
|
339
|
-
- `+create_dashboard` ([doc](references/create_dashboard.md))
|
|
340
|
-
- `+list_dashboards` ([doc](references/list_dashboards.md))
|
|
341
|
-
- `+query_dashboard_detail` ([doc](references/query_dashboard_detail.md))
|
|
342
|
-
- `+query_dashboard_report_data` ([doc](references/query_dashboard_report_data.md))
|
|
343
|
-
- `+update_dashboard` ([doc](references/update_dashboard.md))
|
|
344
|
-
- `+delete_dashboard` ([doc](references/delete_dashboard.md))
|
|
345
|
-
- `+copy_dashboard` ([doc](references/copy_dashboard.md))
|
|
346
|
-
- `+freeze_dashboards` ([doc](references/freeze_dashboards.md))
|
|
347
|
-
- `+move_dashboard` ([doc](references/move_dashboard.md))
|
|
348
|
-
- `+create_or_update_dashboard_note` ([doc](references/create_or_update_dashboard_note.md))
|
|
349
|
-
- `+list_public_access_links` ([doc](references/list_public_access_links.md))
|
|
350
|
-
- `+create_public_access_link` ([doc](references/create_public_access_link.md))
|
|
351
|
-
- `+update_public_access_link` ([doc](references/update_public_access_link.md))
|
|
352
|
-
- `+list_bi_panels` ([doc](references/list_bi_panels.md))
|
|
353
|
-
- `+get_bi_panel_detail` ([doc](references/get_bi_panel_detail.md))
|
|
354
|
-
- `+query_bi_panel_data` ([doc](references/query_bi_panel_data.md))
|
|
379
|
+
|
|
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.
|
|
355
381
|
|
|
356
382
|
Model Analysis (17):
|
|
357
383
|
- `+build_event_analysis_qp` ([doc](references/build_event_analysis_qp.md))
|
|
@@ -0,0 +1,114 @@
|
|
|
1
|
+
# analysis capability-gateway asset commands
|
|
2
|
+
|
|
3
|
+
> Prerequisite: follow [`../SKILL.md`](../SKILL.md), especially `PROJECT_ID_GATE`.
|
|
4
|
+
|
|
5
|
+
These commands use the capability gateway instead of MCP tool names. The CLI command shape is:
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
ae-cli analysis <resource> <action> [options]
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
Flags use kebab-case. The gateway input JSON uses snake_case. Do not pass camelCase flags or payload keys unless a nested backend DTO explicitly requires them inside `--payload`.
|
|
12
|
+
|
|
13
|
+
This file is an overview only. Before running one command, read the dedicated command reference named `references/<resource>_<action>.md` with hyphens converted to underscores, for example `dashboard_report_data_export.md`.
|
|
14
|
+
|
|
15
|
+
## When to use
|
|
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.
|
|
18
|
+
|
|
19
|
+
Prefer export commands for long-running or large data:
|
|
20
|
+
|
|
21
|
+
```bash
|
|
22
|
+
ae-cli analysis dashboard-report-data export --project-id 1 --dashboard-id 1001
|
|
23
|
+
ae-cli analysis bi-panel-page-data export --project-id 1 --panel-id 2001 --page-key main --result-type charts
|
|
24
|
+
ae-cli analysis query cancel --run-id run_0123456789abcdef0123456789abcdef
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
## When not to use
|
|
28
|
+
|
|
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 version/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
|
+
|
|
31
|
+
## Output
|
|
32
|
+
|
|
33
|
+
All commands return the gateway envelope:
|
|
34
|
+
|
|
35
|
+
```json
|
|
36
|
+
{
|
|
37
|
+
"ok": true,
|
|
38
|
+
"data": {},
|
|
39
|
+
"meta": {}
|
|
40
|
+
}
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
Failures return:
|
|
44
|
+
|
|
45
|
+
```json
|
|
46
|
+
{
|
|
47
|
+
"ok": false,
|
|
48
|
+
"error": {
|
|
49
|
+
"code": "INVALID_QUERY_REQUEST",
|
|
50
|
+
"message": "..."
|
|
51
|
+
}
|
|
52
|
+
}
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
Export commands return `run_id`, `artifact_id`, `status`, `artifact_status`, `inspect_path`, `download_path`, `expires_at`, and `expires_at_iso`. Download the artifact through the returned path; cancel by `run_id`.
|
|
56
|
+
|
|
57
|
+
## Command matrix
|
|
58
|
+
|
|
59
|
+
| Command | Capability ID | Use for | Key input | Output |
|
|
60
|
+
| --- | --- | --- | --- | --- |
|
|
61
|
+
| `dashboard list` | `analysis.dashboard.list` | Find accessible dashboards | `--project-id`, optional `--query`, `--fields`, `--limit`, `--offset` | Paginated dashboard summaries |
|
|
62
|
+
| `dashboard create` | `analysis.dashboard.create` | Create a dashboard | `--project-id`, `--dashboard-name`, optional `--space-id`, `--folder-id` | Created dashboard |
|
|
63
|
+
| `dashboard get` | `analysis.dashboard.get` | Inspect one dashboard definition/share/report structure, including creator and creation/update time | `--project-id`, `--dashboard-id` | Dashboard detail |
|
|
64
|
+
| `dashboard update` | `analysis.dashboard.update` | Update settings or upsert a note | `--operation settings|note-upsert`, IDs, optional `--payload` | Update result |
|
|
65
|
+
| `dashboard share-info` | `analysis.dashboard.share_info` | Read dashboard sharing info | `--project-id`, `--dashboard-id` | Share info |
|
|
66
|
+
| `dashboard share` | `analysis.dashboard.share` | Modify dashboard sharing | `--project-id`, `--dashboard-id`, `--payload` or `--member-authorities` | Share update result |
|
|
67
|
+
| `dashboard delete` | `analysis.dashboard.delete` | Delete dashboards | `--project-id`, `--dashboard-ids '[...]'` | Delete result |
|
|
68
|
+
| `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 |
|
|
70
|
+
| `dashboard freeze` | `analysis.dashboard.freeze` | Freeze/unfreeze dashboards | `--dashboard-ids`, optional `--freeze false` | Freeze status |
|
|
71
|
+
| `dashboard abnormal-get` | `analysis.dashboard.abnormal_get` | Inspect abnormal dependencies | `--dashboard-id` | Abnormal info |
|
|
72
|
+
| `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 |
|
|
74
|
+
| `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 |
|
|
75
|
+
| `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 |
|
|
77
|
+
| `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 |
|
|
80
|
+
| `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 |
|
|
82
|
+
| `bi-panel create` | `analysis.bi_panel.create` | Create a BI panel | optional `--panel-name`, `--payload` | Created panel |
|
|
83
|
+
| `bi-panel update` | `analysis.bi_panel.update` | Update BI panel content/metadata | optional `--payload` | Update result |
|
|
84
|
+
| `bi-panel delete` | `analysis.bi_panel.delete` | Delete BI panels | `--panel-ids '[...]'` | Delete result |
|
|
85
|
+
| `bi-panel share` | `analysis.bi_panel.share` | Modify BI panel sharing | `--panel-id`, `--payload` | Share update result |
|
|
86
|
+
| `bi-panel copy` | `analysis.bi_panel.copy` | Copy a BI panel | optional source/target flags and `--payload` | Copied panel |
|
|
87
|
+
| `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
|
+
| `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
|
+
| `project-space list` | `analysis.project_space.list` | Find accessible project spaces | `--project-id`, optional list filters | Paginated project spaces |
|
|
90
|
+
| `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 |
|
|
92
|
+
| `project-space delete` | `analysis.project_space.delete` | Delete project spaces | `--space-id` or `--space-ids` | Delete result |
|
|
93
|
+
| `project-space share` | `analysis.project_space.share` | Modify project-space members | `--space-id`, `--payload` | Share update result |
|
|
94
|
+
| `project-space members` | `analysis.project_space.members` | Read project-space members | `--space-id` | Members |
|
|
95
|
+
| `folder create` | `analysis.folder.create` | Create personal/project-space folder | `--folder-name`, optional `--space-id`, `--parent-folder-id` | Created folder |
|
|
96
|
+
| `folder delete` | `analysis.folder.delete` | Delete folders | `--folder-id` or `--folder-ids`, optional `--space-id` | Delete result |
|
|
97
|
+
| `folder share` | `analysis.folder.share` | Modify folder members | `--folder-id`, `--payload` | Share update result |
|
|
98
|
+
| `folder members` | `analysis.folder.members` | Read folder members | `--folder-id` | Members |
|
|
99
|
+
| `favorite add` | `analysis.favorite.add` | Favorite dashboard/BI/folder | `--asset-id`, `--asset-type`, optional `--payload` | Favorite result |
|
|
100
|
+
| `favorite remove` | `analysis.favorite.remove` | Remove favorite | same as add | Remove result |
|
|
101
|
+
| `public-link create` | `analysis.public_link.create` | Generate public link | `--resource-type`, `--resource-id`, `--effective-at`, `--expires-at` | Link result |
|
|
102
|
+
| `public-link list` | `analysis.public_link.list` | List public links | `--project-id`, optional list filters | Paginated links |
|
|
103
|
+
| `public-link update` | `analysis.public_link.update` | Edit public link | `--link-id`, `--effective-at`, `--expires-at` | Update result |
|
|
104
|
+
| `public-link offline` | `analysis.public_link.offline` | Take links offline | `--link-id` or `--link-ids` | Offline result |
|
|
105
|
+
| `public-link delete` | `analysis.public_link.delete` | Delete public links | `--link-id` or `--link-ids` | Delete result |
|
|
106
|
+
|
|
107
|
+
## Examples
|
|
108
|
+
|
|
109
|
+
```bash
|
|
110
|
+
ae-cli analysis dashboard list --project-id 1 --query retention --limit 20
|
|
111
|
+
ae-cli analysis dashboard update --project-id 1 --operation note-upsert --dashboard-id 1001 --note-title "Summary" --description "Weekly note" --yes
|
|
112
|
+
ae-cli analysis dashboard-definition import --project-id 1 --definition '{"dashboard_folders":[],"shared_spaces":[]}' --validate-only true
|
|
113
|
+
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
|
+
```
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# analysis bi-panel copy
|
|
2
|
+
|
|
3
|
+
Use when the user wants to copy a BI panel, optionally targeting a project space or folder.
|
|
4
|
+
|
|
5
|
+
Do not use to create a blank BI panel. Use `bi-panel create`.
|
|
6
|
+
|
|
7
|
+
Command:
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
ae-cli analysis bi-panel copy --project-id <project_id> [--panel-name <name>] [--panel-uuid <source_uuid>] [--space-id <space_id>] [--folder-id <folder_id>] [--payload '{...}'] --yes
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Input sends `project_id`, optional source/target fields, and `payload`.
|
|
14
|
+
|
|
15
|
+
Output is the gateway envelope. `data` contains the copied BI panel result.
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# analysis bi-panel create
|
|
2
|
+
|
|
3
|
+
Use when the user explicitly wants to create a BI panel.
|
|
4
|
+
|
|
5
|
+
Do not use to copy an existing BI panel. Use `bi-panel copy`.
|
|
6
|
+
|
|
7
|
+
Command:
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
ae-cli analysis bi-panel create --project-id <project_id> [--panel-name <name>] [--panel-uuid <uuid>] [--space-id <space_id>] [--folder-id <folder_id>] [--payload '{...}'] --yes
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Input sends `project_id` plus optional BI panel identifiers, target IDs, and `payload`.
|
|
14
|
+
|
|
15
|
+
Output is the gateway envelope. `data` contains the created BI panel result.
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# analysis bi-panel delete
|
|
2
|
+
|
|
3
|
+
Use when the user explicitly wants to delete one or more BI panels.
|
|
4
|
+
|
|
5
|
+
Do not use for dashboards. Use `dashboard delete`.
|
|
6
|
+
|
|
7
|
+
Command:
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
ae-cli analysis bi-panel delete --project-id <project_id> --panel-ids '[2001,2002]' --yes
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Input sends `project_id` and `panel_ids`.
|
|
14
|
+
|
|
15
|
+
Output is the gateway envelope. `data` contains the delete result.
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# analysis bi-panel get
|
|
2
|
+
|
|
3
|
+
Use when the user needs one BI panel's released page structure.
|
|
4
|
+
|
|
5
|
+
Do not use to query chart data. Use `bi-panel-page-data run` or `bi-panel-page-data export`.
|
|
6
|
+
|
|
7
|
+
Command:
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
ae-cli analysis bi-panel get --project-id <project_id> --panel-id <panel_id> [--fields '["pages"]']
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Input sends `project_id`, `panel_id`, and optional `fields`.
|
|
14
|
+
|
|
15
|
+
Supported fields are `basic`, `pages`, `charts`, `chartFilterControls`, `summary`,
|
|
16
|
+
`parameterControls`, and `permissionControls`.
|
|
17
|
+
|
|
18
|
+
Output is the gateway envelope. `data` contains the BI panel structure.
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# analysis bi-panel list
|
|
2
|
+
|
|
3
|
+
Use when the user needs to find BI panels they can access.
|
|
4
|
+
|
|
5
|
+
Do not use for dashboard assets. Use `dashboard list`.
|
|
6
|
+
|
|
7
|
+
Command:
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
ae-cli analysis bi-panel list --project-id <project_id> [--query <keyword>] [--fields '["id","name"]'] [--limit 20] [--offset 0]
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Input sends `project_id` and optional `query`, `fields`, `limit`, `offset`.
|
|
14
|
+
|
|
15
|
+
Output is the gateway envelope. `data` contains BI panel summaries and paging metadata when returned.
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# analysis bi-panel-page-data export
|
|
2
|
+
|
|
3
|
+
Use for BI panel page data that may be large or long-running.
|
|
4
|
+
|
|
5
|
+
Do not use for tiny previews. Use `bi-panel-page-data run` with a small limit.
|
|
6
|
+
|
|
7
|
+
Command:
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
ae-cli analysis bi-panel-page-data export --project-id <project_id> --panel-id <panel_id> --page-key <page_key> --result-type charts [--chart-ids '["chart1"]'] [--artifact-format jsonl]
|
|
11
|
+
```
|
|
12
|
+
|
|
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
|
+
|
|
15
|
+
Output is the gateway envelope. `data` contains an async export descriptor such as `run_id`, `artifact_id`, status fields, inspect path, and download path.
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# analysis bi-panel-page-data run
|
|
2
|
+
|
|
3
|
+
Use for bounded inline BI panel page chart or summary data.
|
|
4
|
+
|
|
5
|
+
Do not use for large or long-running page data. Use `bi-panel-page-data export`.
|
|
6
|
+
|
|
7
|
+
Command:
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
ae-cli analysis bi-panel-page-data run --project-id <project_id> --panel-id <panel_id> --page-key <page_key> --result-type charts [--chart-ids '["chart1"]'] [--limit 100] [--timeout-seconds 60]
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Input sends `project_id`, `panel_id`, `page_key`, `result_type`, and optional control, paging, cache, request, timeout, and limit fields.
|
|
14
|
+
|
|
15
|
+
Output is the gateway envelope. `data` contains bounded inline page data.
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# analysis bi-panel share
|
|
2
|
+
|
|
3
|
+
Use when the user wants to modify BI panel sharing members.
|
|
4
|
+
|
|
5
|
+
Do not use to share dashboards or folders. Use the matching resource share command.
|
|
6
|
+
|
|
7
|
+
Command:
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
ae-cli analysis bi-panel share --project-id <project_id> --panel-id <panel_id> [--payload '{...}'] --yes
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Input sends `project_id`, `panel_id`, and backend-compatible snake_case `payload`.
|
|
14
|
+
|
|
15
|
+
Output is the gateway envelope. `data` contains the share update result.
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# analysis bi-panel update
|
|
2
|
+
|
|
3
|
+
Use when the user wants to update BI panel content or metadata.
|
|
4
|
+
|
|
5
|
+
Do not use for BI panel version or lock workflows; those are intentionally not CLI-enabled.
|
|
6
|
+
|
|
7
|
+
Command:
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
ae-cli analysis bi-panel update --project-id <project_id> [--panel-name <name>] [--panel-uuid <uuid>] [--payload '{...}'] --yes
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Input sends `project_id`, optional `panel_name`, `panel_uuid`, and `payload`.
|
|
14
|
+
|
|
15
|
+
Output is the gateway envelope. `data` contains the update result.
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# analysis dashboard abnormal-get
|
|
2
|
+
|
|
3
|
+
Use when the user needs abnormal dependency or import/export diagnostic information for one dashboard.
|
|
4
|
+
|
|
5
|
+
Do not use for normal dashboard detail. Use `dashboard get`.
|
|
6
|
+
|
|
7
|
+
Command:
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
ae-cli analysis dashboard abnormal-get --project-id <project_id> --dashboard-id <dashboard_id>
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Input sends `project_id` and `dashboard_id`.
|
|
14
|
+
|
|
15
|
+
Output is the gateway envelope. `data` contains abnormal dependency information.
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# analysis dashboard copy
|
|
2
|
+
|
|
3
|
+
Use when the user wants to copy a dashboard, optionally copying reports and targeting a project space or folder.
|
|
4
|
+
|
|
5
|
+
Do not use to create a blank dashboard. Use `dashboard create`.
|
|
6
|
+
|
|
7
|
+
Command:
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
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
|
+
```
|
|
12
|
+
|
|
13
|
+
Input sends `project_id`, `dashboard_id`, `dashboard_name`, and optional `report_copy`, `to_space_id`, `to_folder_id`.
|
|
14
|
+
|
|
15
|
+
Output is the gateway envelope. `data` contains the copied dashboard result.
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# analysis dashboard create
|
|
2
|
+
|
|
3
|
+
Use when the user explicitly wants to create a dashboard in personal space, a project space, or a folder.
|
|
4
|
+
|
|
5
|
+
Do not use to copy an existing dashboard. Use `dashboard copy` for copy workflows.
|
|
6
|
+
|
|
7
|
+
Command:
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
ae-cli analysis dashboard create --project-id <project_id> --dashboard-name <name> [--space-id <space_id>] [--folder-id <folder_id>] [--initial-report-id <report_id>] [--payload '{...}'] --yes
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Input sends `project_id`, `dashboard_name`, and optional `space_id`, `folder_id`, `initial_report_id`, `payload`.
|
|
14
|
+
|
|
15
|
+
Output is the gateway envelope. `data` contains the created dashboard identity or backend create result.
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# analysis dashboard-daily-report send
|
|
2
|
+
|
|
3
|
+
Use when the user wants to send a dashboard daily report immediately.
|
|
4
|
+
|
|
5
|
+
Do not use for configuration changes. Use `dashboard-daily-report update`.
|
|
6
|
+
|
|
7
|
+
Command:
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
ae-cli analysis dashboard-daily-report send --project-id <project_id> --dashboard-id <dashboard_id> [--need-csv 1] [--host-url <url>] [--payload '{...}'] --yes
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Input sends `project_id`, `dashboard_id`, and optional `need_csv`, `host_url`, `payload`.
|
|
14
|
+
|
|
15
|
+
Output is the gateway envelope. `data` contains the immediate send result.
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# analysis dashboard-daily-report update
|
|
2
|
+
|
|
3
|
+
Use when the user wants to update a dashboard daily report configuration.
|
|
4
|
+
|
|
5
|
+
Do not use to send immediately. Use `dashboard-daily-report send`.
|
|
6
|
+
|
|
7
|
+
Command:
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
ae-cli analysis dashboard-daily-report update --project-id <project_id> --dashboard-id <dashboard_id> [--enable-send 1] [--send-time <time>] [--send-title <title>] [--send-content <content>] [--payload '{...}'] --yes
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Input sends `project_id`, `dashboard_id`, and optional daily report fields or `payload`.
|
|
14
|
+
|
|
15
|
+
Output is the gateway envelope. `data` contains the daily report configuration update result.
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# analysis dashboard-definition export
|
|
2
|
+
|
|
3
|
+
Use when the user wants to export dashboard definition JSON for selected dashboard folders or shared spaces.
|
|
4
|
+
|
|
5
|
+
Do not use for dashboard report result data. Use `dashboard-report-data run` or `dashboard-report-data export`.
|
|
6
|
+
|
|
7
|
+
Command:
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
ae-cli analysis dashboard-definition export --project-id <project_id> [--dashboard-folder-ids '[...]'] [--shared-spaces '[...]'] [--export-file-name <name>] [--payload '{...}']
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Input sends `project_id` and optional `dashboard_folder_ids`, `shared_spaces`, `export_file_name`, `payload`.
|
|
14
|
+
|
|
15
|
+
Output is the gateway envelope. `data` contains exported definition data or an export descriptor.
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# analysis dashboard-definition import
|
|
2
|
+
|
|
3
|
+
Use when the user wants to validate or import dashboard definition JSON. Use `--validate-only true` for pre-checks such as name conflict, reference relation, and importable state.
|
|
4
|
+
|
|
5
|
+
Do not use a separate pre-check command; validation is part of this import command.
|
|
6
|
+
|
|
7
|
+
Command:
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
ae-cli analysis dashboard-definition import --project-id <project_id> --definition '{...}' [--validate-only true] [--dashboard-name-conflict-policy <policy>] [--space-dashboard-policy <policy>] [--payload '{...}'] --yes
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Input sends `project_id`, `definition`, and optional validation/import policies and `payload`.
|
|
14
|
+
|
|
15
|
+
Output is the gateway envelope. `data` contains validation findings or import result.
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# analysis dashboard delete
|
|
2
|
+
|
|
3
|
+
Use when the user explicitly wants to delete one or more dashboards.
|
|
4
|
+
|
|
5
|
+
Do not use for soft archival or hiding unless the gateway contract defines that behavior.
|
|
6
|
+
|
|
7
|
+
Command:
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
ae-cli analysis dashboard delete --project-id <project_id> --dashboard-ids '[1001,1002]' --yes
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Input sends `project_id` and `dashboard_ids`.
|
|
14
|
+
|
|
15
|
+
Output is the gateway envelope. `data` contains the delete result.
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# analysis dashboard freeze
|
|
2
|
+
|
|
3
|
+
Use when the user wants to freeze or unfreeze one or more dashboards.
|
|
4
|
+
|
|
5
|
+
Do not use for dashboard lock/version operations; those are intentionally not CLI-enabled.
|
|
6
|
+
|
|
7
|
+
Command:
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
ae-cli analysis dashboard freeze --project-id <project_id> --dashboard-ids '[1001,1002]' [--freeze true] --yes
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Input sends `project_id`, `dashboard_ids`, and optional `freeze`.
|
|
14
|
+
|
|
15
|
+
Output is the gateway envelope. `data` contains the freeze or unfreeze result.
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# analysis dashboard get
|
|
2
|
+
|
|
3
|
+
Use when the user needs one dashboard detail, including basic metadata such as creator and create/update time, settings, reports, notes, and sharing information.
|
|
4
|
+
|
|
5
|
+
Do not use to query report result data. Use `dashboard-report-data run` or `dashboard-report-data export`.
|
|
6
|
+
|
|
7
|
+
Command:
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
ae-cli analysis dashboard get --project-id <project_id> --dashboard-id <dashboard_id> [--use-cache true]
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Input sends `project_id`, `dashboard_id`, and optional `use_cache`.
|
|
14
|
+
|
|
15
|
+
Output is the gateway envelope. `data` contains the dashboard detail returned by the capability gateway.
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# analysis dashboard handover
|
|
2
|
+
|
|
3
|
+
Use when the user explicitly wants to transfer one or more dashboards to another project user.
|
|
4
|
+
|
|
5
|
+
Do not use to share dashboards without ownership transfer. Use `dashboard share`.
|
|
6
|
+
|
|
7
|
+
Command:
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
ae-cli analysis dashboard handover --project-id <project_id> --dashboard-ids '[1001,1002]' --to-user-id <user_id> --yes
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Input sends `project_id`, `dashboard_ids`, and `to_user_id`.
|
|
14
|
+
|
|
15
|
+
Output is the gateway envelope. `data` contains the handover result.
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# analysis dashboard list
|
|
2
|
+
|
|
3
|
+
Use when the user needs to find dashboards they can access, with optional keyword, owner, permission, favorite, or projection filters supported by the gateway payload.
|
|
4
|
+
|
|
5
|
+
Do not use for dashboard report data. Use `dashboard-report-data run` or `dashboard-report-data export` instead.
|
|
6
|
+
|
|
7
|
+
Command:
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
ae-cli analysis dashboard list --project-id <project_id> [--query <keyword>] [--fields '["id","name"]'] [--limit 20] [--offset 0]
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Input uses `project_id` plus optional `query`, `fields`, `limit`, `offset`. Use `--payload` only when the dedicated gateway contract requires extra snake_case filters.
|
|
14
|
+
|
|
15
|
+
Output is the gateway envelope. `data` contains dashboard summaries and paging metadata when returned by the gateway.
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# analysis dashboard-report-data export
|
|
2
|
+
|
|
3
|
+
Use for dashboard report data queries that may be large or long-running.
|
|
4
|
+
|
|
5
|
+
Do not use when the user needs a tiny immediate preview. Use `dashboard-report-data run` with a small `--limit`.
|
|
6
|
+
|
|
7
|
+
Command:
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
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]
|
|
11
|
+
```
|
|
12
|
+
|
|
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
|
+
|
|
15
|
+
Output is the gateway envelope. `data` contains an async export descriptor such as `run_id`, `artifact_id`, status fields, inspect path, and download path.
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# analysis dashboard-report-data run
|
|
2
|
+
|
|
3
|
+
Use for bounded inline dashboard report data queries when the expected result is small enough for immediate JSON output.
|
|
4
|
+
|
|
5
|
+
Do not use for large or long-running result sets. Use `dashboard-report-data export`.
|
|
6
|
+
|
|
7
|
+
Command:
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
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 60]
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Input sends `project_id`, `dashboard_id`, and optional `report_ids`, `filters`, `start_time`, `end_time`, `use_cache`, `request_id`, `timeout_seconds`, `limit`.
|
|
14
|
+
|
|
15
|
+
Output is the gateway envelope. `data` contains bounded inline report data.
|