@thinkingai/ae-cli 1.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +229 -0
- package/bin/ae-cli.js +2 -0
- package/dist/auth-JXELJNDS.js +19 -0
- package/dist/auth-L3G3A74I.js +67 -0
- package/dist/chunk-3GM5LJZR.js +145 -0
- package/dist/chunk-JD5DXMKL.js +172 -0
- package/dist/chunk-KM57HI5B.js +107 -0
- package/dist/chunk-OVQOK35G.js +108 -0
- package/dist/chunk-RJNLN3KQ.js +217 -0
- package/dist/client-5QSQBBDB.js +16 -0
- package/dist/community-GMALVSRF.js +684 -0
- package/dist/config-Q7J3Z7Z2.js +242 -0
- package/dist/index.js +277 -0
- package/dist/raw-ZNVURYMR.js +59 -0
- package/dist/te-analysis-7NN3SY3I.js +871 -0
- package/dist/te-audience-P43BWMHM.js +350 -0
- package/dist/te-common-H3IPTI2I.js +144 -0
- package/dist/te-dataops-WCGDBJLF.js +1853 -0
- package/dist/te-engage-UTRVNTGU.js +1470 -0
- package/dist/te-meta-HGYNXVGF.js +479 -0
- package/package.json +53 -0
- package/skills/te-analysis/SKILL.md +107 -0
- package/skills/te-analysis/references/build-entity-details-sql.md +58 -0
- package/skills/te-analysis/references/build-event-details-sql.md +61 -0
- package/skills/te-analysis/references/create-alert.md +47 -0
- package/skills/te-analysis/references/create-dashboard.md +49 -0
- package/skills/te-analysis/references/create-or-update-dashboard-note.md +39 -0
- package/skills/te-analysis/references/create-public-access-link.md +43 -0
- package/skills/te-analysis/references/create-report.md +60 -0
- package/skills/te-analysis/references/create-result-cluster.md +73 -0
- package/skills/te-analysis/references/drilldown-user-events.md +72 -0
- package/skills/te-analysis/references/drilldown-users.md +75 -0
- package/skills/te-analysis/references/get-alert-definition-schema.md +32 -0
- package/skills/te-analysis/references/get-alert.md +31 -0
- package/skills/te-analysis/references/get-analysis-query-schema.md +36 -0
- package/skills/te-analysis/references/get-filter-schema.md +33 -0
- package/skills/te-analysis/references/get-groupby-schema.md +33 -0
- package/skills/te-analysis/references/get-report-definition.md +33 -0
- package/skills/te-analysis/references/get-table-columns.md +38 -0
- package/skills/te-analysis/references/list-alerts.md +33 -0
- package/skills/te-analysis/references/list-dashboards.md +33 -0
- package/skills/te-analysis/references/list-public-access-links.md +31 -0
- package/skills/te-analysis/references/list-reports.md +33 -0
- package/skills/te-analysis/references/load-filters.md +44 -0
- package/skills/te-analysis/references/query-adhoc.md +71 -0
- package/skills/te-analysis/references/query-dashboard-detail.md +35 -0
- package/skills/te-analysis/references/query-dashboard-report-data.md +60 -0
- package/skills/te-analysis/references/query-entity-details.md +60 -0
- package/skills/te-analysis/references/query-event-details.md +63 -0
- package/skills/te-analysis/references/query-report-data.md +65 -0
- package/skills/te-analysis/references/update-alert.md +49 -0
- package/skills/te-analysis/references/update-dashboard.md +45 -0
- package/skills/te-analysis/references/update-public-access-link.md +41 -0
- package/skills/te-audience/SKILL.md +63 -0
- package/skills/te-audience/references/create-cluster.md +65 -0
- package/skills/te-audience/references/create-tag.md +60 -0
- package/skills/te-audience/references/get-cluster-definition-schema.md +37 -0
- package/skills/te-audience/references/get-clusters-by-name.md +32 -0
- package/skills/te-audience/references/get-tag-definition-schema.md +32 -0
- package/skills/te-audience/references/get-tags-by-name.md +32 -0
- package/skills/te-audience/references/list-cluster-members.md +35 -0
- package/skills/te-audience/references/list-clusters.md +32 -0
- package/skills/te-audience/references/list-tag-members.md +36 -0
- package/skills/te-audience/references/list-tags.md +32 -0
- package/skills/te-audience/references/refresh-cluster.md +31 -0
- package/skills/te-audience/references/refresh-tag.md +31 -0
- package/skills/te-audience/references/update-cluster.md +59 -0
- package/skills/te-audience/references/update-tag.md +60 -0
- package/skills/te-common/SKILL.md +135 -0
- package/skills/te-common/references/get-resource-url.md +32 -0
- package/skills/te-common/references/list-projects.md +37 -0
- package/skills/te-community/SKILL.md +133 -0
- package/skills/te-community/references/community-activity-analysis.md +68 -0
- package/skills/te-community/references/community-analyzing-official-content.md +72 -0
- package/skills/te-community/references/community-analyzing-theme-comment.md +124 -0
- package/skills/te-community/references/community-character-analysis.md +71 -0
- package/skills/te-community/references/community-daily-report.md +82 -0
- package/skills/te-community/references/community-hottopic-insight.md +120 -0
- package/skills/te-community/references/community-release-analysis.md +79 -0
- package/skills/te-community/references/community-weekly-report.md +84 -0
- package/skills/te-community/references/get_channel_info.md +21 -0
- package/skills/te-community/references/get_comment_tag_analysis.md +30 -0
- package/skills/te-community/references/get_comments_summary.md +33 -0
- package/skills/te-community/references/get_corpus_tags.md +21 -0
- package/skills/te-community/references/get_daily_summary.md +23 -0
- package/skills/te-community/references/get_hot_topics.md +26 -0
- package/skills/te-community/references/get_livestream_analysis.md +23 -0
- package/skills/te-community/references/get_livestream_detail.md +34 -0
- package/skills/te-community/references/get_livestream_list.md +26 -0
- package/skills/te-community/references/get_livestream_overview.md +25 -0
- package/skills/te-community/references/get_livestream_room_metrics.md +26 -0
- package/skills/te-community/references/get_livestream_rooms.md +26 -0
- package/skills/te-community/references/get_overview_metrics.md +26 -0
- package/skills/te-community/references/get_post_detail.md +38 -0
- package/skills/te-community/references/get_risk_content.md +43 -0
- package/skills/te-community/references/get_sentiment_overview.md +34 -0
- package/skills/te-community/references/get_tag_trends.md +28 -0
- package/skills/te-community/references/get_topic_detail.md +27 -0
- package/skills/te-community/references/search_posts.md +48 -0
- package/skills/te-dataops/SKILL.md +645 -0
- package/skills/te-dataops/references/dataops-flow-create.md +163 -0
- package/skills/te-dataops/references/dataops-flow-monitor.md +118 -0
- package/skills/te-dataops/references/dataops-integration.md +246 -0
- package/skills/te-dataops/references/dataops-operations.md +107 -0
- package/skills/te-dataops/references/dataops-query.md +111 -0
- package/skills/te-dataops/references/dataops-table.md +122 -0
- package/skills/te-engage/SKILL.md +211 -0
- package/skills/te-engage/references/add-approver.md +24 -0
- package/skills/te-engage/references/add-channel.md +74 -0
- package/skills/te-engage/references/approver-list.md +19 -0
- package/skills/te-engage/references/cancel-query-by-request-id.md +23 -0
- package/skills/te-engage/references/channel-detail.md +52 -0
- package/skills/te-engage/references/channel-list.md +41 -0
- package/skills/te-engage/references/config-channel-detail.md +32 -0
- package/skills/te-engage/references/config-channel-list.md +27 -0
- package/skills/te-engage/references/config-item-analysis-report.md +34 -0
- package/skills/te-engage/references/config-item-detail.md +30 -0
- package/skills/te-engage/references/config-item-list.md +19 -0
- package/skills/te-engage/references/config-item-strategy-comparison.md +25 -0
- package/skills/te-engage/references/config-item-trigger-report.md +42 -0
- package/skills/te-engage/references/copy-config-template.md +29 -0
- package/skills/te-engage/references/delete-channel.md +24 -0
- package/skills/te-engage/references/delete-config-channel.md +24 -0
- package/skills/te-engage/references/delete-config-item.md +25 -0
- package/skills/te-engage/references/delete-flow.md +24 -0
- package/skills/te-engage/references/flow-ab-split-node-report.md +54 -0
- package/skills/te-engage/references/flow-detail.md +79 -0
- package/skills/te-engage/references/flow-list.md +19 -0
- package/skills/te-engage/references/flow-node-config-schema.md +44 -0
- package/skills/te-engage/references/flow-node-detail-report.md +55 -0
- package/skills/te-engage/references/flow-node-overview-report.md +52 -0
- package/skills/te-engage/references/flow-process-report.md +59 -0
- package/skills/te-engage/references/manage-flow.md +94 -0
- package/skills/te-engage/references/manage-strategy.md +74 -0
- package/skills/te-engage/references/manage-task.md +37 -0
- package/skills/te-engage/references/modify-flow-base-info.md +27 -0
- package/skills/te-engage/references/save-flow.md +870 -0
- package/skills/te-engage/references/strategy-detail.md +73 -0
- package/skills/te-engage/references/strategy-list.md +21 -0
- package/skills/te-engage/references/task-data-detail.md +81 -0
- package/skills/te-engage/references/task-data-overview.md +48 -0
- package/skills/te-engage/references/task-detail.md +61 -0
- package/skills/te-engage/references/task-experiment-report.md +51 -0
- package/skills/te-engage/references/task-list.md +91 -0
- package/skills/te-engage/references/task-metric-detail.md +56 -0
- package/skills/te-engage/references/task-stats.md +89 -0
- package/skills/te-engage/references/update-channel-status.md +32 -0
- package/skills/te-engage/references/update-config-channel-status.md +32 -0
- package/skills/te-engage/references/validate-flow-node-config.md +52 -0
- package/skills/te-engage/references/whitelist-list.md +19 -0
- package/skills/te-meta/SKILL.md +71 -0
- package/skills/te-meta/references/batch-create-metadata.md +37 -0
- package/skills/te-meta/references/batch-edit-metadata.md +36 -0
- package/skills/te-meta/references/create-metric.md +62 -0
- package/skills/te-meta/references/create-project-mark-time.md +38 -0
- package/skills/te-meta/references/create-virtual-event.md +64 -0
- package/skills/te-meta/references/create-virtual-property.md +69 -0
- package/skills/te-meta/references/delete-project-mark-times.md +34 -0
- package/skills/te-meta/references/delete-track-items.md +35 -0
- package/skills/te-meta/references/get-metric.md +32 -0
- package/skills/te-meta/references/get-project-config.md +32 -0
- package/skills/te-meta/references/get-track-program.md +31 -0
- package/skills/te-meta/references/list-entities.md +34 -0
- package/skills/te-meta/references/list-events.md +33 -0
- package/skills/te-meta/references/list-metrics.md +33 -0
- package/skills/te-meta/references/list-project-mark-times.md +33 -0
- package/skills/te-meta/references/list-project-users.md +32 -0
- package/skills/te-meta/references/list-properties.md +35 -0
- package/skills/te-meta/references/save-track-items.md +34 -0
- package/skills/te-meta/references/update-metric.md +61 -0
- package/skills/te-meta/references/update-project-mark-time.md +39 -0
- package/skills/te-shared/SKILL.md +115 -0
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# te_analysis +get_alert (view alert definition)
|
|
2
|
+
|
|
3
|
+
> **Prerequisite:** Read [`../te-shared/SKILL.md`](../../te-shared/SKILL.md)
|
|
4
|
+
|
|
5
|
+
Domain: **Metadata Lookup**
|
|
6
|
+
|
|
7
|
+
## Use Cases
|
|
8
|
+
- Get detailed information about a specific alert by alertId.
|
|
9
|
+
|
|
10
|
+
## Commands
|
|
11
|
+
```bash
|
|
12
|
+
te-cli te_analysis +get_alert --project_id 1 --alert_id 1
|
|
13
|
+
te-cli te_analysis +get_alert --dry-run
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
## Parameters
|
|
17
|
+
| Parameter | Required | Description |
|
|
18
|
+
|---|---|---|
|
|
19
|
+
| `--project_id` / `-p` | Yes | Project ID |
|
|
20
|
+
| `--alert_id` / `-a` | Yes | Alert ID |
|
|
21
|
+
|
|
22
|
+
## Decision Rules
|
|
23
|
+
- For the first run, it is recommended to pass only the required parameters (`--project_id`, `--alert_id`) and add optional parameters after confirming the chain works.
|
|
24
|
+
- For cross-project troubleshooting, first confirm whether `--project_id` matches the current permissions and target environment.
|
|
25
|
+
|
|
26
|
+
## Next Step After Failure
|
|
27
|
+
- If required parameters are missing, fall back to the smallest runnable command and fill them in (focus on `--project_id`, `--alert_id`).
|
|
28
|
+
- If reading fails, first verify whether the object ID exists and belongs to the current project.
|
|
29
|
+
|
|
30
|
+
## Recommended Chaining
|
|
31
|
+
- +get_alert
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
# te_analysis +get_analysis_query_schema (Get Analysis Query Schema)
|
|
2
|
+
|
|
3
|
+
> **Prerequisite:** Read [`../te-shared/SKILL.md`](../../te-shared/SKILL.md)
|
|
4
|
+
|
|
5
|
+
Domain: **Model schema queries**
|
|
6
|
+
|
|
7
|
+
- This is the documentation for the `+get_analysis_query_schema` command; read it before running `ae-cli te_analysis +get_analysis_query_schema`.
|
|
8
|
+
- Get the query schema for the specified analysis model type. Different model types use different schema structures. This tool returns field definitions and examples.
|
|
9
|
+
|
|
10
|
+
## Use Cases
|
|
11
|
+
- Helper tool positioning: this command provides structural definitions (schema) and should be used as a prerequisite step.
|
|
12
|
+
- Recommended order: first use the current schema tool to get the structure, then call the specific business tool.
|
|
13
|
+
- Typical follow-up tools: `+create_metric`, `+create_report`, `+drilldown_users`, `+get_cluster_definition_schema`, `+get_filter_schema`, `+get_groupby_schema`, `+get_tag_definition_schema`, `+query_adhoc`
|
|
14
|
+
- Get the analysis query schema for the specified model type. Different model types use different query structures. This tool returns field definitions and examples. Supported model types: event, retention, funnel, distribution, sql, interval, path, attribution, prop_analysis, rank_list, heat_map.
|
|
15
|
+
- Get the analysis query schema for the specified model type.
|
|
16
|
+
|
|
17
|
+
## Command
|
|
18
|
+
```bash
|
|
19
|
+
ae-cli te_analysis +get_analysis_query_schema --model_type event
|
|
20
|
+
ae-cli te_analysis +get_analysis_query_schema --model_type event --dry-run
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
## Parameters
|
|
24
|
+
| Parameter | Required | Description |
|
|
25
|
+
|---|---|---|
|
|
26
|
+
| `--model_type` | Yes | Model type. Supported values: event, retention, funnel, distribution, sql, interval, path, attribution, prop_analysis, rank_list, heat_map |
|
|
27
|
+
|
|
28
|
+
## Decision Rules
|
|
29
|
+
- It is recommended to run `--dry-run` first to inspect the request body mapping before making the formal call.
|
|
30
|
+
|
|
31
|
+
## Next Steps on Failure
|
|
32
|
+
- If reading fails, first verify whether the object ID exists and belongs to the current project.
|
|
33
|
+
- If the schema does not match expectations, confirm whether the correct schema interface was called (filter/groupby/query/tag/cluster).
|
|
34
|
+
|
|
35
|
+
## Recommended chaining
|
|
36
|
+
- +get_analysis_query_schema -> +get_filter_schema -> +get_groupby_schema
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
# te_analysis +get_filter_schema (get filter schema)
|
|
2
|
+
|
|
3
|
+
> **Prerequisite:** Read [`../te-shared/SKILL.md`](../../te-shared/SKILL.md)
|
|
4
|
+
|
|
5
|
+
Domain: **Schema Queries**
|
|
6
|
+
|
|
7
|
+
## Use Cases
|
|
8
|
+
- Helper tool positioning: this command provides structure definitions (schema) and should be used as a prerequisite step.
|
|
9
|
+
- Recommended order: call the schema tool first to get the structure, then call the specific business tool.
|
|
10
|
+
- Typical downstream tools: `+create_virtual_event`, `+get_analysis_query_schema`, `+get_cluster_definition_schema`, `+get_groupby_schema`, `+get_tag_definition_schema`, `+query_dashboard_report_data`, `+query_report_data`
|
|
11
|
+
- Get the filter schema. Returns field definitions, operator enums, data type descriptions, and examples.
|
|
12
|
+
- Get the filter schema.
|
|
13
|
+
|
|
14
|
+
## Commands
|
|
15
|
+
```bash
|
|
16
|
+
te-cli te_analysis +get_filter_schema
|
|
17
|
+
te-cli te_analysis +get_filter_schema --dry-run
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
## Parameters
|
|
21
|
+
| Parameter | Required | Description |
|
|
22
|
+
|---|---|---|
|
|
23
|
+
| None | - | This command has no business parameters; call it directly. |
|
|
24
|
+
|
|
25
|
+
## Decision Rules
|
|
26
|
+
- It is recommended to run `--dry-run` first to observe the request-body mapping before making the formal call.
|
|
27
|
+
|
|
28
|
+
## Next Step After Failure
|
|
29
|
+
- If reading fails, first verify whether the object ID exists and belongs to the current project.
|
|
30
|
+
- If the schema does not match expectations, confirm whether the correct schema interface was called (filter/groupby/query/tag/cluster).
|
|
31
|
+
|
|
32
|
+
## Recommended Chaining
|
|
33
|
+
- +get_analysis_query_schema -> +get_filter_schema -> +get_groupby_schema
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
# te_analysis +get_groupby_schema (Get Group-By Schema)
|
|
2
|
+
|
|
3
|
+
> **Prerequisite:** Read [`../te-shared/SKILL.md`](../../te-shared/SKILL.md)
|
|
4
|
+
|
|
5
|
+
Domain: **Schema queries**
|
|
6
|
+
|
|
7
|
+
## Use Cases
|
|
8
|
+
- Helper tool positioning: this command provides structural definitions (schema) and should be used as a prerequisite step.
|
|
9
|
+
- Recommended order: first use the current schema tool to get the structure, then call the specific business tool.
|
|
10
|
+
- Typical follow-up tools: `+get_analysis_query_schema`, `+get_cluster_definition_schema`, `+get_filter_schema`, `+get_tag_definition_schema`, `+query_report_data`
|
|
11
|
+
- Get the group-by schema. Returns field definitions and examples for group-by configuration.
|
|
12
|
+
- Get the group-by schema.
|
|
13
|
+
|
|
14
|
+
## Command
|
|
15
|
+
```bash
|
|
16
|
+
te-cli te_analysis +get_groupby_schema
|
|
17
|
+
te-cli te_analysis +get_groupby_schema --dry-run
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
## Parameters
|
|
21
|
+
| Parameter | Required | Description |
|
|
22
|
+
|---|---|---|
|
|
23
|
+
| None | - | This command has no business parameters; call it directly. |
|
|
24
|
+
|
|
25
|
+
## Decision Rules
|
|
26
|
+
- It is recommended to run `--dry-run` first to inspect the request body mapping before making the formal call.
|
|
27
|
+
|
|
28
|
+
## Next Steps on Failure
|
|
29
|
+
- If reading fails, first verify whether the object ID exists and belongs to the current project.
|
|
30
|
+
- If the schema does not match expectations, confirm whether the correct schema interface was called (filter/groupby/query/tag/cluster).
|
|
31
|
+
|
|
32
|
+
## Recommended chaining
|
|
33
|
+
- +get_analysis_query_schema -> +get_filter_schema -> +get_groupby_schema
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
# te_analysis +get_report_definition (read report definition)
|
|
2
|
+
|
|
3
|
+
> **Prerequisite:** Read [`../te-shared/SKILL.md`](../../te-shared/SKILL.md)
|
|
4
|
+
|
|
5
|
+
Domain: **Report Management**
|
|
6
|
+
|
|
7
|
+
## Use Cases
|
|
8
|
+
- Get the definition details of a single report. Returns model type, event configuration, display configuration, and other definition data without executing a data query.
|
|
9
|
+
- Get the definition details of a single report.
|
|
10
|
+
- When interpreting report information, remember that for recent-day ranges, 1-N means the last N days (past N days), which is actually N+1 days ago through yesterday, while 0-N means the most recent N days, which is actually N days ago through today.
|
|
11
|
+
|
|
12
|
+
## Commands
|
|
13
|
+
```bash
|
|
14
|
+
te-cli te_analysis +get_report_definition --project_id 1 --report_id 1
|
|
15
|
+
te-cli te_analysis +get_report_definition --dry-run
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
## Parameters
|
|
19
|
+
| Parameter | Required | Description |
|
|
20
|
+
|---|---|---|
|
|
21
|
+
| `--project_id` / `-p` | Yes | Project ID |
|
|
22
|
+
| `--report_id` / `-r` | Yes | Report ID |
|
|
23
|
+
|
|
24
|
+
## Decision Rules
|
|
25
|
+
- For the first run, it is recommended to pass only the required parameters (`--project_id`, `--report_id`) and add optional parameters after confirming the chain works.
|
|
26
|
+
- For cross-project troubleshooting, first confirm whether `--project_id` matches the current permissions and target environment.
|
|
27
|
+
|
|
28
|
+
## Next Step After Failure
|
|
29
|
+
- If required parameters are missing, fall back to the smallest runnable command and fill them in (focus on `--project_id`, `--report_id`).
|
|
30
|
+
- If reading fails, first verify whether the object ID exists and belongs to the current project.
|
|
31
|
+
|
|
32
|
+
## Recommended Chaining
|
|
33
|
+
- +list_reports -> +get_report_definition -> +query_report_data
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
# te_analysis +get_table_columns (Read Underlying Table Columns)
|
|
2
|
+
|
|
3
|
+
> **Prerequisite:** Read [`../te-shared/SKILL.md`](../../te-shared/SKILL.md)
|
|
4
|
+
|
|
5
|
+
Domain: **Model analysis**
|
|
6
|
+
|
|
7
|
+
## Use Cases
|
|
8
|
+
- Query the field list of a project table. Returns all column names and types under the specified catalog, schema, and table so the table schema can be understood before SQL analysis.
|
|
9
|
+
- Table guide:
|
|
10
|
+
- default.public.ta_event_1: catalog is default, schema is public, table is ta_event_1
|
|
11
|
+
- public.ta_event_1: catalog is hive(default value), schema is public, table is ta_event_1
|
|
12
|
+
- ta_event_1: catalog is hive(default value), schema is ta(default value), table is ta_event_1
|
|
13
|
+
- Query the field list of a project table.
|
|
14
|
+
|
|
15
|
+
## Command
|
|
16
|
+
```bash
|
|
17
|
+
te-cli te_analysis +get_table_columns --project_id 1 --catalog demo --schema demo --table demo
|
|
18
|
+
te-cli te_analysis +get_table_columns --dry-run
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
## Parameters
|
|
22
|
+
| Parameter | Required | Description |
|
|
23
|
+
|---|---|---|
|
|
24
|
+
| `--project_id` / `-p` | Yes | Project ID |
|
|
25
|
+
| `--catalog` | Yes | Catalog name, default hive |
|
|
26
|
+
| `--schema` | Yes | Schema name, default ta |
|
|
27
|
+
| `--table` | Yes | Table name |
|
|
28
|
+
|
|
29
|
+
## Decision Rules
|
|
30
|
+
- On the first run, start with only the required parameters (`--project_id`,`--catalog`,`--schema`), and add optional parameters after confirming the path works.
|
|
31
|
+
- For cross-project troubleshooting, first confirm whether `--project_id` matches the current permissions and target environment.
|
|
32
|
+
|
|
33
|
+
## Next Steps on Failure
|
|
34
|
+
- If required parameters are missing, fall back to the smallest runnable command and fill them in first (focus on `--project_id`, `--catalog`, `--schema`).
|
|
35
|
+
- If reading fails, first verify whether the object ID exists and belongs to the current project.
|
|
36
|
+
|
|
37
|
+
## Recommended chaining
|
|
38
|
+
- +get_table_columns
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
# te_analysis +list_alerts (alert strategy search)
|
|
2
|
+
|
|
3
|
+
> **Prerequisite:** Read [`../te-shared/SKILL.md`](../../te-shared/SKILL.md)
|
|
4
|
+
|
|
5
|
+
Domain: **Metadata Lookup**
|
|
6
|
+
|
|
7
|
+
## Use Cases
|
|
8
|
+
- List all alerts in the project. Supports keyword filtering by alert name. Returns a paginated list containing alerts array and pager result with total count.
|
|
9
|
+
- List all alerts in the project.
|
|
10
|
+
|
|
11
|
+
## Commands
|
|
12
|
+
```bash
|
|
13
|
+
te-cli te_analysis +list_alerts --project_id 1
|
|
14
|
+
te-cli te_analysis +list_alerts --project_id 1 --query demo
|
|
15
|
+
te-cli te_analysis +list_alerts --dry-run
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
## Parameters
|
|
19
|
+
| Parameter | Required | Description |
|
|
20
|
+
|---|---|---|
|
|
21
|
+
| `--project_id` / `-p` | Yes | Project ID |
|
|
22
|
+
| `--query` / `-q` | No | Optional keyword filter. Performs fuzzy matching against alert names; if omitted, all alerts are returned. |
|
|
23
|
+
|
|
24
|
+
## Decision Rules
|
|
25
|
+
- For the first run, it is recommended to pass only the required parameters (`--project_id`) and add optional parameters after confirming the chain works.
|
|
26
|
+
- For cross-project troubleshooting, first confirm whether `--project_id` matches the current permissions and target environment.
|
|
27
|
+
|
|
28
|
+
## Next Step After Failure
|
|
29
|
+
- If required parameters are missing, fall back to the smallest runnable command and fill them in (focus on `--project_id`).
|
|
30
|
+
- If the result is empty, first confirm the project ID/keyword, then try broadening the filter conditions.
|
|
31
|
+
|
|
32
|
+
## Recommended Chaining
|
|
33
|
+
- +list_alerts
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
# te_analysis +list_dashboards (List Dashboards)
|
|
2
|
+
|
|
3
|
+
> **Prerequisite:** Read [`../te-shared/SKILL.md`](../../te-shared/SKILL.md)
|
|
4
|
+
|
|
5
|
+
Domain: **Dashboard management**
|
|
6
|
+
|
|
7
|
+
## Use Cases
|
|
8
|
+
- List dashboard metadata accessible to the current user in the project. Supports keyword filtering and returns dashboard IDs, names, descriptions, and related metadata, but not dashboard configuration or report data.
|
|
9
|
+
- List dashboard metadata accessible to the current user in the project.
|
|
10
|
+
|
|
11
|
+
## Command
|
|
12
|
+
```bash
|
|
13
|
+
ae-cli te_analysis +list_dashboards --project_id 1
|
|
14
|
+
ae-cli te_analysis +list_dashboards --project_id 1 --query demo
|
|
15
|
+
ae-cli te_analysis +list_dashboards --dry-run
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
## Parameters
|
|
19
|
+
| Parameter | Required | Description |
|
|
20
|
+
|---|---|---|
|
|
21
|
+
| `--project_id` / `-p` | Yes | Project ID |
|
|
22
|
+
| `--query` / `-q` | No | Optional keyword filter. Performs fuzzy matching against dashboard names; if omitted, all accessible dashboards are returned. |
|
|
23
|
+
|
|
24
|
+
## Decision Rules
|
|
25
|
+
- On the first run, start with only the required parameters (`--project_id`), and add optional parameters after confirming the path works.
|
|
26
|
+
- For cross-project troubleshooting, first confirm whether `--project_id` matches the current permissions and target environment.
|
|
27
|
+
|
|
28
|
+
## Next Steps on Failure
|
|
29
|
+
- If required parameters are missing, fall back to the smallest runnable command and fill them in first (focus on `--project_id`).
|
|
30
|
+
- If the result is empty, first confirm the project ID / keyword, then try loosening the filter conditions.
|
|
31
|
+
|
|
32
|
+
## Recommended chaining
|
|
33
|
+
- +list_dashboards -> +query_dashboard_detail -> +query_dashboard_report_data
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# te_analysis +list_public_access_links (public link search)
|
|
2
|
+
|
|
3
|
+
> **Prerequisite:** Read [`../te-shared/SKILL.md`](../../te-shared/SKILL.md)
|
|
4
|
+
|
|
5
|
+
Domain: **Dashboard Management**
|
|
6
|
+
|
|
7
|
+
## Use Cases
|
|
8
|
+
- List public access links in the project. Returns link IDs, short codes, access targets, status, effective time, expiration time, and related metadata.
|
|
9
|
+
- List public access links in the project.
|
|
10
|
+
|
|
11
|
+
## Commands
|
|
12
|
+
```bash
|
|
13
|
+
te-cli te_analysis +list_public_access_links --project_id 1
|
|
14
|
+
te-cli te_analysis +list_public_access_links --dry-run
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
## Parameters
|
|
18
|
+
| Parameter | Required | Description |
|
|
19
|
+
|---|---|---|
|
|
20
|
+
| `--project_id` / `-p` | Yes | Project ID |
|
|
21
|
+
|
|
22
|
+
## Decision Rules
|
|
23
|
+
- For the first run, it is recommended to pass only the required parameters (`--project_id`) and add optional parameters after confirming the chain works.
|
|
24
|
+
- For cross-project troubleshooting, first confirm whether `--project_id` matches the current permissions and target environment.
|
|
25
|
+
|
|
26
|
+
## Next Step After Failure
|
|
27
|
+
- If required parameters are missing, fall back to the smallest runnable command and fill them in (focus on `--project_id`).
|
|
28
|
+
- If the result is empty, first confirm the project ID/keyword, then try broadening the filter conditions.
|
|
29
|
+
|
|
30
|
+
## Recommended Chaining
|
|
31
|
+
- +list_public_access_links -> +update_public_access_link
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
# te_analysis +list_reports (List Reports)
|
|
2
|
+
|
|
3
|
+
> **Prerequisite:** Read [`../te-shared/SKILL.md`](../../te-shared/SKILL.md)
|
|
4
|
+
|
|
5
|
+
Domain: **Report management**
|
|
6
|
+
|
|
7
|
+
## Use Cases
|
|
8
|
+
- List report metadata accessible to the current user in the project. Supports keyword filtering and returns report IDs, names, model types, update times, and related metadata, but not report definitions or analysis data.
|
|
9
|
+
- List report metadata accessible to the current user in the project.
|
|
10
|
+
|
|
11
|
+
## Command
|
|
12
|
+
```bash
|
|
13
|
+
ae-cli te_analysis +list_reports --project_id 1
|
|
14
|
+
ae-cli te_analysis +list_reports --project_id 1 --query demo
|
|
15
|
+
ae-cli te_analysis +list_reports --dry-run
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
## Parameters
|
|
19
|
+
| Parameter | Required | Description |
|
|
20
|
+
|---|---|---|
|
|
21
|
+
| `--project_id` / `-p` | Yes | Project ID |
|
|
22
|
+
| `--query` / `-q` | No | Optional keyword filter. Performs fuzzy matching against report names and descriptions; if omitted, all accessible reports are returned. |
|
|
23
|
+
|
|
24
|
+
## Decision Rules
|
|
25
|
+
- On the first run, start with only the required parameters (`--project_id`), and add optional parameters after confirming the path works.
|
|
26
|
+
- For cross-project troubleshooting, first confirm whether `--project_id` matches the current permissions and target environment.
|
|
27
|
+
|
|
28
|
+
## Next Steps on Failure
|
|
29
|
+
- If required parameters are missing, fall back to the smallest runnable command and fill them in first (focus on `--project_id`).
|
|
30
|
+
- If the result is empty, first confirm the project ID / keyword, then try loosening the filter conditions.
|
|
31
|
+
|
|
32
|
+
## Recommended chaining
|
|
33
|
+
- +list_reports -> +get_report_definition -> +query_report_data
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
# te_analysis +load_filters (load filter candidate values)
|
|
2
|
+
|
|
3
|
+
> **Prerequisite:** Read [`../te-shared/SKILL.md`](../../te-shared/SKILL.md)
|
|
4
|
+
|
|
5
|
+
Domain: **Model Analysis**
|
|
6
|
+
|
|
7
|
+
## Use Cases
|
|
8
|
+
- Load candidate values for a property. Queries the available enum values of the specified property (quot), which is useful when building filter conditions.
|
|
9
|
+
- tableType values:
|
|
10
|
+
- event: event property
|
|
11
|
+
- user: user property
|
|
12
|
+
- clusterDatePolicy is only used when tableType=user and user clusters are involved. Supported values: LATEST, AUTO, SPECIFIED.
|
|
13
|
+
- Load candidate values for a property.
|
|
14
|
+
|
|
15
|
+
## Commands
|
|
16
|
+
```bash
|
|
17
|
+
te-cli te_analysis +load_filters --project_id 1 --quot demo --table_type event
|
|
18
|
+
te-cli te_analysis +load_filters --project_id 1 --quot demo --table_type event --event_name demo --inputdata demo --zone_offset 8 --cluster_date_policy SPECIFIED --specified_cluster_date 2026-04-08 --is_report true
|
|
19
|
+
te-cli te_analysis +load_filters --dry-run
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
## Parameters
|
|
23
|
+
| Parameter | Required | Description |
|
|
24
|
+
|---|---|---|
|
|
25
|
+
| `--project_id` / `-p` | Yes | Project ID |
|
|
26
|
+
| `--quot` | Yes | Property identifier (field name). This is the property whose candidate values will be loaded. |
|
|
27
|
+
| `--table_type` | Yes | Table type: event for event properties, user for user properties |
|
|
28
|
+
| `--event_name` | No | Optional event name. When tableType=event, this can limit the query scope to a specific event. |
|
|
29
|
+
| `--inputdata` | No | Optional input prefix used for fuzzy filtering of candidate values. If omitted, all candidate values are returned. |
|
|
30
|
+
| `--zone_offset` | No | Time zone offset in hours. For example, UTC+8 is 8 |
|
|
31
|
+
| `--cluster_date_policy` | No | Cluster date policy: LATEST, AUTO, or SPECIFIED |
|
|
32
|
+
| `--specified_cluster_date` | No | Specified cluster date in yyyy-MM-dd format. Effective only when clusterDatePolicy=SPECIFIED. |
|
|
33
|
+
| `--is_report` | No | Whether this is report mode. Default: false |
|
|
34
|
+
|
|
35
|
+
## Decision Rules
|
|
36
|
+
- For the first run, it is recommended to pass only the required parameters (`--project_id`, `--quot`, `--table_type`) and add optional parameters after confirming the chain works.
|
|
37
|
+
- When dates/time ranges are involved, validate with a short range first and then expand gradually.
|
|
38
|
+
- For cross-project troubleshooting, first confirm whether `--project_id` matches the current permissions and target environment.
|
|
39
|
+
|
|
40
|
+
## Next Step After Failure
|
|
41
|
+
- If required parameters are missing, fall back to the smallest runnable command and fill them in (focus on `--project_id`, `--quot`, `--table_type`).
|
|
42
|
+
|
|
43
|
+
## Recommended Chaining
|
|
44
|
+
- +load_filters
|
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
# te_analysis +query_adhoc (Ad Hoc Analysis Execution)
|
|
2
|
+
|
|
3
|
+
> **Prerequisite:** Read [`../te-shared/SKILL.md`](../../te-shared/SKILL.md)
|
|
4
|
+
|
|
5
|
+
Domain: **Model analysis**
|
|
6
|
+
|
|
7
|
+
## Use Cases
|
|
8
|
+
- Precondition helper: call `+get_analysis_query_schema` to get the structure before using this tool.
|
|
9
|
+
- When constructing a real `qp`, you must supplement it with real project metadata; first call `te_meta +list_events` and `te_meta +list_properties`.
|
|
10
|
+
- Event analysis: metrics such as event trigger counts, user counts, sums, averages, and more.
|
|
11
|
+
- Retention analysis: metrics such as user churn and retention.
|
|
12
|
+
- Funnel analysis: metrics such as multi-step conversion.
|
|
13
|
+
- Distribution analysis: bucketed distribution analysis.
|
|
14
|
+
- Attribution analysis: multi-touch attribution analysis (first touch, last touch, linear attribution).
|
|
15
|
+
- Interval analysis: time interval analysis between events.
|
|
16
|
+
- Path analysis: user behavior path analysis.
|
|
17
|
+
- Property analysis: user property distribution analysis.
|
|
18
|
+
- Heat map: visual heat map analysis of user interactions.
|
|
19
|
+
- Rank list: ranking / leaderboard analysis.
|
|
20
|
+
- SQL: custom SQL analysis.
|
|
21
|
+
- Process: fetch events/properties and the schema first, then assemble the query JSON, and finally execute the analysis.
|
|
22
|
+
|
|
23
|
+
## Mandatory prerequisites (MUST)
|
|
24
|
+
- Before constructing `--qp`, you must first read and follow these reference documents:
|
|
25
|
+
- [`./get-analysis-query-schema.md`](./get-analysis-query-schema.md)
|
|
26
|
+
- [`../../te-meta/references/list-events.md`](../../te-meta/references/list-events.md)
|
|
27
|
+
- [`../../te-meta/references/list-properties.md`](../../te-meta/references/list-properties.md)
|
|
28
|
+
- Do not generate the final `qp` until the documentation review and prerequisite command calls are complete.
|
|
29
|
+
|
|
30
|
+
## Prerequisite call chain (required for constructing qp)
|
|
31
|
+
1. First determine `--model_type`.
|
|
32
|
+
2. Read `get-analysis-query-schema.md`, then call `te-cli te_analysis +get_analysis_query_schema --model_type <model_type>` to get the structure.
|
|
33
|
+
3. Read `list-events.md`, then call `te-cli te_meta +list_events --project_id 1` to get the available events.
|
|
34
|
+
4. Read `list-properties.md`, then call `te-cli te_meta +list_properties --project_id 1` to get the available properties.
|
|
35
|
+
5. Build `qp` from the schema + metadata, then call `+query_adhoc`.
|
|
36
|
+
|
|
37
|
+
## Command
|
|
38
|
+
```bash
|
|
39
|
+
te-cli te_analysis +query_adhoc --project_id 1 --model_type event --qp '{}'
|
|
40
|
+
te-cli te_analysis +query_adhoc --project_id 1 --model_type event --qp '{}' --zone_offset 8 --request_id demo --use_cache true --is_sort_by_columns true --resolve_recent_day true --timeout_minutes 8
|
|
41
|
+
te-cli te_analysis +query_adhoc --dry-run
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
## Parameters
|
|
45
|
+
| Parameter | Required | Description |
|
|
46
|
+
|---|---|---|
|
|
47
|
+
| `--project_id` / `-p` | Yes | Project ID used to identify the analysis project |
|
|
48
|
+
| `--model_type` | Yes | Model type. Supported values: event, retention, funnel, distribution, attribution, heat_map, interval, path, rank_list, prop_analysis, sql. |
|
|
49
|
+
| `--qp` | Yes | Query parameter JSON. MUST call `+get_analysis_query_schema` first, and use event/property metadata from `te_meta +list_events` / `te_meta +list_properties` in the same `project_id`. |
|
|
50
|
+
| `--request_id` | No | Optional unique request ID used for tracking and deduplication. Generated automatically if omitted. |
|
|
51
|
+
| `--use_cache` | No | Whether to use result cache. Default: true |
|
|
52
|
+
| `--zone_offset` | No | Time zone offset in hours. For example, UTC+8 is 8 and UTC-5 is -5 |
|
|
53
|
+
| `--is_sort_by_columns` | No | Whether to sort query results by columns. Default: false |
|
|
54
|
+
| `--resolve_recent_day` | No | Whether to resolve relative time expressions such as "last 7 days". Default: false |
|
|
55
|
+
| `--timeout_minutes` | No | Query timeout in minutes. If the query exceeds this time, it will be cancelled automatically. |
|
|
56
|
+
|
|
57
|
+
## Decision Rules
|
|
58
|
+
- On the first run, start with only the required parameters (`--project_id`,`--model_type`,`--qp`), and add optional parameters after confirming the path works.
|
|
59
|
+
- `qp` cannot be written from experience alone: it must satisfy both the schema structure and the project metadata constraints.
|
|
60
|
+
- Before calling `list_events` / `list_properties`, you must first study the corresponding reference documents.
|
|
61
|
+
- Wrap JSON parameters in single quotes (for example `--qp '{}'`) to avoid shell escaping issues.
|
|
62
|
+
- For cross-project troubleshooting, first confirm whether `--project_id` matches the current permissions and target environment.
|
|
63
|
+
|
|
64
|
+
## Next Steps on Failure
|
|
65
|
+
- If required parameters are missing, fall back to the smallest runnable command and fill them in first (focus on `--project_id`, `--model_type`, `--qp`).
|
|
66
|
+
- If `Invalid JSON` appears, first check the schema required fields, then verify whether the event/property names come from metadata query results for the same `project_id`.
|
|
67
|
+
- If the query times out or results are abnormal, first narrow the time range / grouping dimensions, then split the subqueries to locate the issue.
|
|
68
|
+
|
|
69
|
+
## Recommended chaining
|
|
70
|
+
- +get_analysis_query_schema -> te_meta +list_events -> te_meta +list_properties -> +query_adhoc
|
|
71
|
+
- +list_events -> +list_properties -> +query_adhoc -> +drilldown_users -> +drilldown_user_events
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
# te_analysis +query_dashboard_detail (read dashboard structure)
|
|
2
|
+
|
|
3
|
+
> **Prerequisite:** Read [`../te-shared/SKILL.md`](../../te-shared/SKILL.md)
|
|
4
|
+
|
|
5
|
+
Domain: **Dashboard Management**
|
|
6
|
+
|
|
7
|
+
## Use Cases
|
|
8
|
+
- Get detailed information about a specific dashboard including:
|
|
9
|
+
- Associated reports (IDs, names, types, and metadata)
|
|
10
|
+
- Dashboard notes (IDs, titles, descriptions)
|
|
11
|
+
- Share members (userId, userName, permissions)
|
|
12
|
+
- Get detailed information about a specific dashboard including: - Associated reports (IDs, names, types, and metadata) - Dashboard notes (IDs, titles, descriptions) - Share members (userId, userName, permissions)
|
|
13
|
+
|
|
14
|
+
## Commands
|
|
15
|
+
```bash
|
|
16
|
+
te-cli te_analysis +query_dashboard_detail --project_id 1 --dashboard_id 1
|
|
17
|
+
te-cli te_analysis +query_dashboard_detail --dry-run
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
## Parameters
|
|
21
|
+
| Parameter | Required | Description |
|
|
22
|
+
|---|---|---|
|
|
23
|
+
| `--project_id` / `-p` | Yes | Project ID |
|
|
24
|
+
| `--dashboard_id` / `-d` | Yes | Dashboard ID |
|
|
25
|
+
|
|
26
|
+
## Decision Rules
|
|
27
|
+
- For the first run, it is recommended to pass only the required parameters (`--project_id`, `--dashboard_id`) and add optional parameters after confirming the chain works.
|
|
28
|
+
- For cross-project troubleshooting, first confirm whether `--project_id` matches the current permissions and target environment.
|
|
29
|
+
|
|
30
|
+
## Next Step After Failure
|
|
31
|
+
- If required parameters are missing, fall back to the smallest runnable command and fill them in (focus on `--project_id`, `--dashboard_id`).
|
|
32
|
+
- If the query times out or the result is abnormal, first reduce the time range/grouping dimensions, then split the query to locate the issue.
|
|
33
|
+
|
|
34
|
+
## Recommended Chaining
|
|
35
|
+
- +list_dashboards -> +query_dashboard_detail -> +query_dashboard_report_data
|
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
# te_analysis +query_dashboard_report_data (Batch Query Dashboard Report Data)
|
|
2
|
+
|
|
3
|
+
> **Prerequisite:** Read [`../te-shared/SKILL.md`](../../te-shared/SKILL.md)
|
|
4
|
+
|
|
5
|
+
Domain: **Dashboard management**
|
|
6
|
+
|
|
7
|
+
## Use Cases
|
|
8
|
+
- Precondition helper: call `+get_filter_schema` to get the structure before using this tool.
|
|
9
|
+
- When constructing `filters`, you must supplement it with real event/property metadata from the project.
|
|
10
|
+
- Query analysis data for one or more reports in a dashboard. Returns actual analysis results without the dashboard definition. Supports additional filters and time range overrides.
|
|
11
|
+
- Query analysis data for one or more reports in a dashboard.
|
|
12
|
+
|
|
13
|
+
## Mandatory prerequisites (MUST)
|
|
14
|
+
- Before constructing `--filters`, you must first read and follow these reference documents:
|
|
15
|
+
- [`./get-filter-schema.md`](./get-filter-schema.md)
|
|
16
|
+
- [`../../te-meta/references/list-events.md`](../../te-meta/references/list-events.md)
|
|
17
|
+
- [`../../te-meta/references/list-properties.md`](../../te-meta/references/list-properties.md)
|
|
18
|
+
- Do not generate the final `filters` until the documentation review and prerequisite command calls are complete.
|
|
19
|
+
|
|
20
|
+
## Prerequisite call chain (required for constructing filters)
|
|
21
|
+
1. Read `get-filter-schema.md`, then call `te-cli te_analysis +get_filter_schema` to get the filter structure.
|
|
22
|
+
2. Read `list-events.md`, then call `te-cli te_meta +list_events --project_id 1`.
|
|
23
|
+
3. Read `list-properties.md`, then call `te-cli te_meta +list_properties --project_id 1`.
|
|
24
|
+
4. Build `filters` from the schema + metadata, then call `+query_dashboard_report_data`.
|
|
25
|
+
|
|
26
|
+
## Command
|
|
27
|
+
```bash
|
|
28
|
+
te-cli te_analysis +query_dashboard_report_data --project_id 1 --dashboard_id 1
|
|
29
|
+
te-cli te_analysis +query_dashboard_report_data --project_id 1 --dashboard_id 1 --filters '{}' --start_date 2026-04-08 --end_date 2026-04-08 --time_granularity day --use_cache true --report_ids '[1001]'
|
|
30
|
+
te-cli te_analysis +query_dashboard_report_data --dry-run
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
## Parameters
|
|
34
|
+
| Parameter | Required | Description |
|
|
35
|
+
|---|---|---|
|
|
36
|
+
| `--project_id` / `-p` | Yes | Project ID |
|
|
37
|
+
| `--dashboard_id` / `-d` | Yes | Dashboard ID |
|
|
38
|
+
| `--filters` | No | Optional filter JSON. If provided, MUST follow `+get_filter_schema`, and referenced fields must come from `te_meta +list_properties` in the same `project_id`. |
|
|
39
|
+
| `--start_date` | No | Optional start date. Format: yyyy-MM-dd |
|
|
40
|
+
| `--end_date` | No | Optional end date. Format: yyyy-MM-dd |
|
|
41
|
+
| `--time_granularity` | No | Optional time granularity used to override the report default. Supported values: minute, minute5, minute10, hour, day, week, month, quarter, year, total. |
|
|
42
|
+
| `--use_cache` | No | Whether to use cache. Default: true |
|
|
43
|
+
| `--report_ids` | No | Optional list of report IDs. If omitted, all reports in the dashboard are queried. |
|
|
44
|
+
|
|
45
|
+
## Decision Rules
|
|
46
|
+
- `filters` cannot be written from experience alone: it must satisfy both the filter schema and the project metadata constraints.
|
|
47
|
+
- Before calling `list_events` / `list_properties`, you must first study the corresponding reference documents.
|
|
48
|
+
- On the first run, start with only the required parameters (`--project_id`, `--dashboard_id`) and add optional parameters after confirming the path works.
|
|
49
|
+
- Wrap JSON parameters in single quotes (for example `--filters '{}'`, `--report_ids '[]'`) to avoid shell escaping issues.
|
|
50
|
+
- When dates/time ranges are involved, first verify with a short range, then gradually expand the range.
|
|
51
|
+
- For cross-project troubleshooting, first confirm whether `--project_id` matches the current permissions and target environment.
|
|
52
|
+
|
|
53
|
+
## Next Steps on Failure
|
|
54
|
+
- If required parameters are missing, fall back to the smallest runnable command and fill them in first (focus on `--project_id`, `--dashboard_id`).
|
|
55
|
+
- If `Invalid JSON` appears, first check the filter schema required fields, then verify whether the event/property names come from metadata query results for the same `project_id`.
|
|
56
|
+
- If the query times out or results are abnormal, first narrow the time range / grouping dimensions, then split the subqueries to locate the issue.
|
|
57
|
+
|
|
58
|
+
## Recommended chaining
|
|
59
|
+
- +get_filter_schema -> te_meta +list_events -> te_meta +list_properties -> +query_dashboard_report_data
|
|
60
|
+
- +list_dashboards -> +query_dashboard_detail -> +query_dashboard_report_data
|
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
# te_analysis +query_entity_details (query entity details)
|
|
2
|
+
|
|
3
|
+
> **Prerequisite:** Read [`../te-shared/SKILL.md`](../../te-shared/SKILL.md)
|
|
4
|
+
|
|
5
|
+
Domain: **Entity Detail Queries**
|
|
6
|
+
|
|
7
|
+
## Use Cases
|
|
8
|
+
- When building `definition`, first obtain the cluster schema and supplement it with the project's real event/property metadata.
|
|
9
|
+
- Query entity detail data. Returns user detail results based on the entity ID and cluster definition, and supports display properties, sorting, and result limits.
|
|
10
|
+
- Query entity detail data.
|
|
11
|
+
|
|
12
|
+
## Mandatory Prerequisites (MUST)
|
|
13
|
+
- Before building `--definition` / `--properties`, you must first read and follow the following reference docs:
|
|
14
|
+
- [`../../te-audience/references/get-cluster-definition-schema.md`](../../te-audience/references/get-cluster-definition-schema.md)
|
|
15
|
+
- [`../../te-meta/references/list-events.md`](../../te-meta/references/list-events.md)
|
|
16
|
+
- [`../../te-meta/references/list-properties.md`](../../te-meta/references/list-properties.md)
|
|
17
|
+
- Do not generate final `definition` / `properties` until the above docs have been read and the prerequisite commands have been called.
|
|
18
|
+
|
|
19
|
+
## Prerequisite Call Chain (required for building definition/properties)
|
|
20
|
+
1. First confirm the cluster type (condition / sql).
|
|
21
|
+
2. Read `get-cluster-definition-schema.md`, then call `ae-cli te_audience +get_cluster_definition_schema --cluster_type <condition|sql>` to get the structure.
|
|
22
|
+
3. Read `list-events.md`, then call `ae-cli te_meta +list_events --project_id 1`.
|
|
23
|
+
4. Read `list-properties.md`, then call `ae-cli te_meta +list_properties --project_id 1`.
|
|
24
|
+
5. Build `definition` (and optional `properties`) based on the schema and metadata, then call `+query_entity_details`.
|
|
25
|
+
|
|
26
|
+
## Commands
|
|
27
|
+
```bash
|
|
28
|
+
ae-cli te_analysis +query_entity_details --project_id 1 --definition '{}'
|
|
29
|
+
ae-cli te_analysis +query_entity_details --project_id 1 --entity_id 1001 --definition '{}' --properties '{}' --sort_by time --sort_order desc --limit 100 --zone_offset 8 --use_cache true
|
|
30
|
+
ae-cli te_analysis +query_entity_details --dry-run
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
## Parameters
|
|
34
|
+
| Parameter | Required | Description |
|
|
35
|
+
|---|---|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
36
|
+
| `--project_id` / `-p` | Yes | Project ID |
|
|
37
|
+
| `--entity_id` | No | Optional entity ID used in multi-entity scenarios. If omitted, the default user entity is used. |
|
|
38
|
+
| `--definition` | Yes | Cluster definition JSON. MUST call `+get_cluster_definition_schema` first, then fill valid event/property names from `te_meta +list_events` / `te_meta +list_properties` in the same `project_id`. |
|
|
39
|
+
| `--properties` | No | Optional display properties JSON, for example `[{"columnName":"#user_id","tableType":"0"},{"columnName":"device_id","tableType":"0"}]`. If provided, property names should come from `te_meta +list_properties` in the same `project_id`. |
|
|
40
|
+
| `--sort_by` | No | Optional sort field |
|
|
41
|
+
| `--sort_order` | No | Optional sort order. Supported values: asc and desc |
|
|
42
|
+
| `--limit` | No | Optional result limit. Default: 1000, maximum: 10000 |
|
|
43
|
+
| `--zone_offset` | No | Time zone offset. For example, UTC+8 is 8 |
|
|
44
|
+
| `--use_cache` | No | Whether to use cache. Default: true |
|
|
45
|
+
|
|
46
|
+
## Decision Rules
|
|
47
|
+
- `definition` / `properties` cannot be written by hand based on experience alone: they must satisfy both the schema structure and the project's real metadata.
|
|
48
|
+
- `list_events` / `list_properties` must be learned from the corresponding reference docs before calling them.
|
|
49
|
+
- For the first run, it is recommended to pass only the required parameters (`--project_id`, `--definition`) and add optional parameters after confirming the chain works.
|
|
50
|
+
- Wrap JSON parameters in single quotes (for example `--definition '{}'`, `--properties '{}'`) to avoid shell escaping issues.
|
|
51
|
+
- For cross-project troubleshooting, first confirm whether `--project_id` matches the current permissions and target environment.
|
|
52
|
+
|
|
53
|
+
## Next Step After Failure
|
|
54
|
+
- If required parameters are missing, fall back to the smallest runnable command and fill them in (focus on `--project_id`, `--definition`).
|
|
55
|
+
- If `Invalid JSON` appears, first check the required schema fields, then verify that the event name/property name comes from metadata queried in the same `project_id`.
|
|
56
|
+
- If the query times out or the result is abnormal, first reduce the time range/grouping dimensions, then split the query to locate the issue.
|
|
57
|
+
|
|
58
|
+
## Recommended Chaining
|
|
59
|
+
- +get_cluster_definition_schema -> te_meta +list_events -> te_meta +list_properties -> +query_entity_details
|
|
60
|
+
- +query_entity_details -> +query_event_details -> +build_event_details_sql
|