@thinkingai/ae-cli 6.0.31 → 6.1.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -2
- package/README.zh.md +3 -2
- package/dist/{capability-SQ2IWKP3.js → capability-QW4AVJHI.js} +1 -1
- package/dist/{capability-SEH3JWLN.js → capability-SCRFGODD.js} +1 -1
- package/dist/{chunk-N2QORU5D.js → chunk-7OLGDQQ2.js} +5 -2
- package/dist/{chunk-TKQJQXWT.js → chunk-TBHBYKXZ.js} +5 -2
- package/dist/index.js +51 -24
- package/dist/{metadata-X62TKIVK.js → metadata-BFDL6RUK.js} +2 -2
- package/dist/{metadata-W6JFFMBA.js → metadata-FCLDBXX2.js} +2 -2
- package/dist/{te-analysis-NJGNWZFC.js → te-analysis-PUVF5IF4.js} +1297 -91
- package/dist/{te-analysis-YGV5V5EX.js → te-analysis-UJDOKPAN.js} +1297 -91
- package/dist/te-common-VUX3VOXZ.js +60 -0
- package/dist/te-common-XLAGWNIV.js +60 -0
- package/dist/te-engage-K4AEUPK5.js +3894 -0
- package/dist/te-engage-QBCCME22.js +3894 -0
- package/dist/te-experiment-JINSMHMW.js +606 -0
- package/dist/te-experiment-NWNQHJS5.js +606 -0
- package/dist/{te-kb-NT33UHAE.js → te-kb-AYCODNU6.js} +56 -17
- package/dist/{te-meta-VKWNAWO4.js → te-meta-ARDIW3YI.js} +1 -234
- package/dist/{te-meta-MAAUHFQO.js → te-meta-UUROEODR.js} +1 -234
- package/package.json +2 -1
- package/skills/ae-analysis/SKILL.md +10 -7
- package/skills/ae-analysis/references/adhoc_export.md +3 -6
- package/skills/ae-analysis/references/adhoc_run.md +5 -9
- package/skills/ae-analysis/references/ai_models.md +17 -1
- package/skills/ae-analysis/references/analysis_data_retrieval.md +11 -11
- package/skills/ae-analysis/references/analysis_drilldown_contract.md +93 -0
- package/skills/ae-analysis/references/analysis_gateway_assets.md +9 -8
- package/skills/ae-analysis/references/asset_url_get.md +4 -3
- package/skills/ae-analysis/references/bi_panel_page_data_export.md +2 -2
- package/skills/ae-analysis/references/bi_panel_page_data_run.md +1 -1
- package/skills/ae-analysis/references/command_index.md +62 -28
- package/skills/ae-analysis/references/create_entity.md +2 -2
- package/skills/ae-analysis/references/dashboard_report_data_export.md +2 -2
- package/skills/ae-analysis/references/dashboard_report_data_run.md +2 -2
- package/skills/ae-analysis/references/drilldown_entities_export.md +26 -0
- package/skills/ae-analysis/references/drilldown_entities_run.md +33 -0
- package/skills/ae-analysis/references/drilldown_events_export.md +21 -0
- package/skills/ae-analysis/references/drilldown_events_run.md +23 -0
- package/skills/ae-analysis/references/drilldown_user_events_export.md +6 -3
- package/skills/ae-analysis/references/drilldown_user_events_run.md +6 -6
- package/skills/ae-analysis/references/entity_detail_export.md +2 -0
- package/skills/ae-analysis/references/entity_detail_run.md +8 -1
- package/skills/ae-analysis/references/event_detail_export.md +2 -0
- package/skills/ae-analysis/references/event_detail_run.md +2 -0
- package/skills/ae-analysis/references/event_list.md +10 -2
- package/skills/ae-analysis/references/list_entities.md +1 -1
- package/skills/ae-analysis/references/metric_create.md +13 -4
- package/skills/ae-analysis/references/metric_delete.md +7 -0
- package/skills/ae-analysis/references/metric_get.md +6 -0
- package/skills/ae-analysis/references/metric_list.md +16 -3
- package/skills/ae-analysis/references/metric_update.md +12 -1
- package/skills/ae-analysis/references/project_access_detail_get.md +23 -0
- package/skills/ae-analysis/references/project_data_power_delete.md +26 -0
- package/skills/ae-analysis/references/project_data_power_get.md +24 -0
- package/skills/ae-analysis/references/project_data_power_list.md +23 -0
- package/skills/ae-analysis/references/project_data_power_upsert.md +24 -0
- package/skills/ae-analysis/references/project_entity_create.md +27 -0
- package/skills/ae-analysis/references/project_entity_delete.md +25 -0
- package/skills/ae-analysis/references/project_entity_event_list.md +24 -0
- package/skills/ae-analysis/references/project_entity_get.md +24 -0
- package/skills/ae-analysis/references/project_entity_list.md +28 -0
- package/skills/ae-analysis/references/project_entity_update.md +28 -0
- package/skills/ae-analysis/references/project_function_list.md +24 -0
- package/skills/ae-analysis/references/project_info_get.md +23 -0
- package/skills/ae-analysis/references/project_info_list.md +26 -0
- package/skills/ae-analysis/references/project_info_update.md +25 -0
- package/skills/ae-analysis/references/project_mark_time_create.md +27 -0
- package/skills/ae-analysis/references/project_mark_time_delete.md +25 -0
- package/skills/ae-analysis/references/project_mark_time_list.md +28 -0
- package/skills/ae-analysis/references/project_mark_time_update.md +28 -0
- package/skills/ae-analysis/references/project_member_add.md +25 -0
- package/skills/ae-analysis/references/project_member_batch_update.md +24 -0
- package/skills/ae-analysis/references/project_member_candidate_list.md +25 -0
- package/skills/ae-analysis/references/project_member_handover_export.md +27 -0
- package/skills/ae-analysis/references/project_member_handover_run.md +24 -0
- package/skills/ae-analysis/references/project_member_import.md +25 -0
- package/skills/ae-analysis/references/project_member_list.md +23 -0
- package/skills/ae-analysis/references/project_member_receiver_list.md +23 -0
- package/skills/ae-analysis/references/project_member_remove.md +26 -0
- package/skills/ae-analysis/references/project_member_update.md +25 -0
- package/skills/ae-analysis/references/project_owner_update.md +27 -0
- package/skills/ae-analysis/references/project_permission_binding_list.md +24 -0
- package/skills/ae-analysis/references/project_receive_status_update.md +25 -0
- package/skills/ae-analysis/references/project_role_delete.md +25 -0
- package/skills/ae-analysis/references/project_role_function_list.md +27 -0
- package/skills/ae-analysis/references/project_role_get.md +23 -0
- package/skills/ae-analysis/references/project_role_list.md +25 -0
- package/skills/ae-analysis/references/project_role_upsert.md +24 -0
- package/skills/ae-analysis/references/project_role_user_list.md +23 -0
- package/skills/ae-analysis/references/project_timezone_get.md +23 -0
- package/skills/ae-analysis/references/project_timezone_overview.md +23 -0
- package/skills/ae-analysis/references/project_timezone_update.md +25 -0
- package/skills/ae-analysis/references/project_user_id_items_update.md +24 -0
- package/skills/ae-analysis/references/property_list.md +21 -6
- package/skills/ae-analysis/references/public_link_create.md +1 -1
- package/skills/ae-analysis/references/query_create_result_cluster.md +14 -32
- package/skills/ae-analysis/references/report_create.md +1 -1
- package/skills/ae-analysis/references/report_data_export.md +2 -2
- package/skills/ae-analysis/references/report_data_run.md +2 -2
- package/skills/ae-analysis/references/report_get.md +2 -0
- package/skills/ae-analysis/references/report_update.md +1 -1
- package/skills/ae-analysis/references/user_cluster_create.md +3 -1
- package/skills/ae-analysis/references/user_cluster_get.md +4 -0
- package/skills/ae-analysis/references/user_cluster_refresh.md +4 -2
- package/skills/ae-analysis/references/user_cluster_update.md +3 -1
- package/skills/ae-analysis/references/user_tag_create.md +3 -1
- package/skills/ae-analysis/references/user_tag_get.md +4 -0
- package/skills/ae-analysis/references/user_tag_refresh.md +4 -2
- package/skills/ae-analysis/references/user_tag_update.md +3 -1
- package/skills/ae-analysis/references/virtual_event_create.md +22 -3
- package/skills/ae-analysis/references/virtual_property_create.md +23 -2
- package/skills/ae-engage/SKILL.md +202 -7
- package/skills/ae-engage/references/activity-activity-type.md +42 -0
- package/skills/ae-engage/references/activity-activity.md +70 -0
- package/skills/ae-engage/references/activity-approval.md +53 -0
- package/skills/ae-engage/references/activity-task.md +87 -0
- package/skills/ae-engage/references/activity-topic.md +98 -0
- package/skills/ae-engage/references/approval-approver-delete.md +26 -0
- package/skills/ae-engage/references/channel-test-send.md +37 -0
- package/skills/ae-engage/references/channel-touch-limits-batch-update.md +28 -0
- package/skills/ae-engage/references/channel-touch-limits-save.md +37 -0
- package/skills/ae-engage/references/channel-touch-limits-toggle.md +28 -0
- package/skills/ae-engage/references/channel-update-config.md +36 -0
- package/skills/ae-engage/references/client-param.md +58 -0
- package/skills/ae-engage/references/common-metric.md +75 -0
- package/skills/ae-engage/references/config-table.md +92 -0
- package/skills/ae-engage/references/engage-scene-config-item.md +69 -0
- package/skills/ae-engage/references/operation-log-query.md +1 -1
- package/skills/ae-engage/references/preset-event.md +42 -0
- package/skills/ae-engage/references/push-language.md +39 -0
- package/skills/ae-engage/references/scene-config-channel.md +58 -0
- package/skills/ae-engage/references/scene-config-group.md +62 -0
- package/skills/ae-engage/references/scene-config-item.md +68 -0
- package/skills/ae-engage/references/scene-config-metric.md +79 -0
- package/skills/ae-engage/references/scene-config-param.md +72 -0
- package/skills/ae-engage/references/scene-preset-metric.md +45 -0
- package/skills/ae-engage/references/scene-strategy.md +47 -0
- package/skills/ae-engage/references/scene-template.md +71 -0
- package/skills/ae-engage/references/{ops-delete.md → task-delete.md} +3 -3
- package/skills/ae-engage/references/whitelist.md +72 -0
- package/skills/ae-engage/references/workbench-workbench.md +48 -0
- package/skills/ae-experiment/SKILL.md +64 -0
- package/skills/ae-experiment/references/batch_delete_experiment.md +11 -0
- package/skills/ae-experiment/references/batch_delete_feature.md +11 -0
- package/skills/ae-experiment/references/batch_delete_traffic_layer.md +11 -0
- package/skills/ae-experiment/references/cancel_experiment_query_by_request_id.md +10 -0
- package/skills/ae-experiment/references/check_experiment_ready.md +13 -0
- package/skills/ae-experiment/references/delete_metric.md +11 -0
- package/skills/ae-experiment/references/manage_experiment.md +15 -0
- package/skills/ae-experiment/references/manage_feature_status.md +11 -0
- package/skills/ae-experiment/references/query_bucket_list.md +10 -0
- package/skills/ae-experiment/references/query_experiment_detail.md +11 -0
- package/skills/ae-experiment/references/query_experiment_list.md +10 -0
- package/skills/ae-experiment/references/query_experiment_metric_trend.md +16 -0
- package/skills/ae-experiment/references/query_experiment_report_summary.md +12 -0
- package/skills/ae-experiment/references/query_experiment_sample_size_report.md +16 -0
- package/skills/ae-experiment/references/query_feature_detail.md +12 -0
- package/skills/ae-experiment/references/query_feature_list.md +10 -0
- package/skills/ae-experiment/references/query_metric_detail.md +11 -0
- package/skills/ae-experiment/references/query_metric_list.md +10 -0
- package/skills/ae-experiment/references/query_traffic_layer_detail.md +11 -0
- package/skills/ae-experiment/references/query_traffic_layer_list.md +10 -0
- package/skills/ae-experiment/references/save_experiment.md +17 -0
- package/skills/ae-experiment/references/save_feature.md +13 -0
- package/skills/ae-experiment/references/save_metric.md +13 -0
- package/skills/ae-experiment/references/save_submit_experiment.md +13 -0
- package/skills/ae-experiment/references/save_traffic_layer.md +13 -0
- package/skills/ae-generate-tracking-plan/SKILL.md +8 -5
- package/skills/ae-generate-tracking-plan/references/te-api.md +1 -1
- package/skills/ae-kb/SKILL.md +34 -8
- package/skills/ae-metadata/SKILL.md +1 -1
- package/skills/ae-metadata/references/metadata_event_get.md +4 -4
- package/skills/ae-metadata/references/metadata_property_dimension_table_bind_existing.md +1 -1
- package/skills/ae-metadata/references/metadata_property_get.md +4 -4
- package/dist/te-common-5NJLF3XG.js +0 -130
- package/dist/te-common-7VTJZPII.js +0 -130
- package/dist/te-engage-BUWVSSSK.js +0 -1912
- package/dist/te-engage-EPE3QKDE.js +0 -1912
- package/skills/ae-analysis/references/create_metric.md +0 -58
- package/skills/ae-analysis/references/create_virtual_event.md +0 -60
- package/skills/ae-analysis/references/create_virtual_property.md +0 -69
- package/skills/ae-analysis/references/delete_metric.md +0 -32
- package/skills/ae-analysis/references/drilldown_users_export.md +0 -17
- package/skills/ae-analysis/references/drilldown_users_run.md +0 -61
- package/skills/ae-analysis/references/get_metric.md +0 -38
- package/skills/ae-analysis/references/get_resource_url.md +0 -33
- package/skills/ae-analysis/references/list_events.md +0 -46
- package/skills/ae-analysis/references/list_metrics.md +0 -52
- package/skills/ae-analysis/references/list_properties.md +0 -47
- package/skills/ae-analysis/references/update_metric.md +0 -58
- package/dist/{chunk-HL2AJQ4Q.js → chunk-PTE56QPL.js} +3 -3
|
@@ -1,58 +0,0 @@
|
|
|
1
|
-
# analysis_meta +create_metric (Create Metric)
|
|
2
|
-
|
|
3
|
-
> **Prerequisite:** Follow the Global AE CLI Rules in [`../SKILL.md`](../SKILL.md).
|
|
4
|
-
|
|
5
|
-
Domain: **Metadata Query**
|
|
6
|
-
|
|
7
|
-
## Use Cases
|
|
8
|
-
- When constructing real `events` / `params`, you must supplement project-native metadata; first call `analysis_meta +list_events` and `analysis_meta +list_properties`.
|
|
9
|
-
- Create a metric from analysis configuration.
|
|
10
|
-
- Creates a new metric based on event or retention analysis.
|
|
11
|
-
|
|
12
|
-
## MUST Prerequisites
|
|
13
|
-
- Before constructing `--events` / `--params`, you must first read and follow these reference documents:
|
|
14
|
-
- [`./list_events.md`](./list_events.md)
|
|
15
|
-
- [`./list_properties.md`](./list_properties.md)
|
|
16
|
-
- Do not generate the final `events` / `params` until the document review and prerequisite command calls above are complete.
|
|
17
|
-
|
|
18
|
-
## Prerequisite Call Chain (Required for Constructing events/params)
|
|
19
|
-
1. Determine `--model_type` first (`event` / `retention`).
|
|
20
|
-
2. Read `list_events.md`, then call `ae-cli analysis_meta +list_events --project_id <project_id>` to get available events.
|
|
21
|
-
3. Read `list_properties.md`, then call `ae-cli analysis_meta +list_properties --project_id <project_id>` to get available properties.
|
|
22
|
-
4. Build `events` / `params` from the metric API payload shape and verified metadata, then call `+create_metric`.
|
|
23
|
-
5. If an accessible URL must be returned, apply resource-link completion according to the unified skill constraints (call `analysis_common +get_resource_url`).
|
|
24
|
-
|
|
25
|
-
## Commands
|
|
26
|
-
```bash
|
|
27
|
-
ae-cli analysis_meta +create_metric --project_id <project_id> --name demo --display_name demo --model_type event --events '[]' --params '{}'
|
|
28
|
-
ae-cli analysis_meta +create_metric --project_id <project_id> --name demo --display_name demo --remark demo --model_type event --events '[]' --params '{}'
|
|
29
|
-
ae-cli analysis_meta +create_metric --dry-run
|
|
30
|
-
```
|
|
31
|
-
|
|
32
|
-
## Parameters
|
|
33
|
-
| Parameter | Required | Description |
|
|
34
|
-
|---|---|---|
|
|
35
|
-
| `--project_id` / `-p` | Yes | Project ID |
|
|
36
|
-
| `--name` | Yes | Metric name. Must start with a lowercase letter and contain only lowercase letters, digits, and underscores. Maximum length: 80. |
|
|
37
|
-
| `--display_name` | Yes | Metric display name |
|
|
38
|
-
| `--remark` | No | Optional metric remark |
|
|
39
|
-
| `--model_type` | Yes | Metric model type. Supported values: event and retention |
|
|
40
|
-
| `--events` | Yes | Metric events JSON. Fill event/property fields using metadata from `analysis_meta +list_events` / `analysis_meta +list_properties` in the same `project_id`. |
|
|
41
|
-
| `--params` | Yes | Metric params JSON. Use project metadata from `analysis_meta +list_events` / `analysis_meta +list_properties` when filling referenced fields. |
|
|
42
|
-
|
|
43
|
-
## Decision Rules
|
|
44
|
-
- `events` / `params` must not be handwritten by intuition alone: they must satisfy the metric API payload shape and the project's real metadata constraints.
|
|
45
|
-
- Set `--model_type` first, then use the matching schema; do not mix event/retention structures.
|
|
46
|
-
- Before calling `list_events` / `list_properties`, you must first study the corresponding reference documents.
|
|
47
|
-
- The smallest valid request still requires `--project_id`, `--name`, `--display_name`, `--model_type`, `--events`, and `--params`; do not omit the model definition to “test the path.” Use `--dry-run` with the complete request for preflight.
|
|
48
|
-
- Wrap JSON parameters in single quotes (for example `--events '{}'` and `--params '{}'`) to avoid shell escaping issues.
|
|
49
|
-
- For cross-project troubleshooting, first confirm whether `--project_id` matches the current permissions and target environment.
|
|
50
|
-
- This is an ordinary `write` operation and does not require CLI confirmation.
|
|
51
|
-
|
|
52
|
-
## Next Steps After Failure
|
|
53
|
-
- If required parameters are missing, complete all required fields listed above before retrying.
|
|
54
|
-
- If `Invalid JSON` appears, first check required fields, then verify whether the event and property names come from metadata query results in the same `project_id`.
|
|
55
|
-
- If the result after writing does not match expectations, immediately reread the corresponding list/get interfaces for before-and-after comparison.
|
|
56
|
-
|
|
57
|
-
## Recommended Chaining
|
|
58
|
-
- +list_metrics -> +create_metric -> +get_metric
|
|
@@ -1,60 +0,0 @@
|
|
|
1
|
-
# analysis_meta +create_virtual_event (Create Virtual Event)
|
|
2
|
-
|
|
3
|
-
> **Prerequisite:** Follow the Global AE CLI Rules in [`../SKILL.md`](../SKILL.md).
|
|
4
|
-
|
|
5
|
-
Domain: **Metadata Query**
|
|
6
|
-
|
|
7
|
-
## Use Cases
|
|
8
|
-
- When constructing real `events` / `filter`, you must first obtain the project's available event and property metadata.
|
|
9
|
-
- Create a virtual event that combines multiple events with filters.
|
|
10
|
-
- A virtual event is a composite event defined by combining multiple real events with optional filters.
|
|
11
|
-
- Key parameters:
|
|
12
|
-
- eventName: Unique name for the virtual event (must start with 'ta@'); the name after 'ta@' must start with a letter, and it can contain letters, numbers, and underscores, with a maximum of 60 characters.
|
|
13
|
-
- eventDesc: Display name/description
|
|
14
|
-
- events: JSON array of real events to combine, each with eventName and optional filter.
|
|
15
|
-
|
|
16
|
-
## MUST Prerequisites
|
|
17
|
-
- Before constructing `--events` / `--filter`, you must first read and follow these reference documents:
|
|
18
|
-
- [`./list_events.md`](./list_events.md)
|
|
19
|
-
- [`./list_properties.md`](./list_properties.md)
|
|
20
|
-
- Do not generate the final `events` / `filter` until the document review and prerequisite command calls above are complete.
|
|
21
|
-
|
|
22
|
-
## Prerequisite Call Chain (Required for Constructing events/filter)
|
|
23
|
-
1. Read `list_events.md`, then call `ae-cli analysis_meta +list_events --project_id <project_id>` to get available events.
|
|
24
|
-
2. Read `list_properties.md`, then call `ae-cli analysis_meta +list_properties --project_id <project_id>` to get properties available for filtering.
|
|
25
|
-
3. Build `events` / `filter` from the command payload shape and verified metadata, then call `+create_virtual_event`.
|
|
26
|
-
4. Example events JSON: `[{"eventName":"purchase"},{"eventName":"add_to_cart"}]`
|
|
27
|
-
|
|
28
|
-
## Commands
|
|
29
|
-
```bash
|
|
30
|
-
ae-cli analysis_meta +create_virtual_event --project_id <project_id> --event_name ta@demo --event_desc demo --events '[{"eventName":"purchase"}]'
|
|
31
|
-
ae-cli analysis_meta +create_virtual_event --project_id <project_id> --event_name ta@demo2 --event_desc demo --remark demo --events '[{"eventName":"add_to_cart"}]' --filter '{}' --override true
|
|
32
|
-
ae-cli analysis_meta +create_virtual_event --dry-run
|
|
33
|
-
```
|
|
34
|
-
|
|
35
|
-
## Parameters
|
|
36
|
-
| Parameter | Required | Description |
|
|
37
|
-
|---|---|---|
|
|
38
|
-
| `--project_id` / `-p` | Yes | Project ID |
|
|
39
|
-
| `--event_name` | Yes | Unique name for the virtual event (must start with 'ta@') |
|
|
40
|
-
| `--event_desc` | Yes | Display name/description |
|
|
41
|
-
| `--remark` | No | Optional remarks |
|
|
42
|
-
| `--events` | Yes | JSON array of events to combine. Event/property fields must come from `analysis_meta +list_events` / `analysis_meta +list_properties` in the same `project_id`. |
|
|
43
|
-
| `--filter` | No | Optional global filter JSON for all events. If provided, referenced fields must come from `analysis_meta +list_properties`. |
|
|
44
|
-
| `--override` | No | Whether to override if event already exists. Default: false |
|
|
45
|
-
|
|
46
|
-
## Decision Rules
|
|
47
|
-
- `events` / `filter` must not be handwritten by intuition alone: they must satisfy the command payload shape and the project's real metadata constraints.
|
|
48
|
-
- Before calling `list_events` / `list_properties`, you must first study the corresponding reference documents.
|
|
49
|
-
- For the first run, pass only the required parameters (`--project_id`, `--event_name`, `--event_desc`, `--events`) to confirm the path works, then add optional parameters.
|
|
50
|
-
- Wrap JSON parameters in single quotes (for example `--events '{}'` and `--filter '{}'`) to avoid shell escaping issues.
|
|
51
|
-
- For cross-project troubleshooting, first confirm whether `--project_id` matches the current permissions and target environment.
|
|
52
|
-
- This is an ordinary `write` operation and does not require CLI confirmation.
|
|
53
|
-
|
|
54
|
-
## Next Steps After Failure
|
|
55
|
-
- If required parameters are missing, fall back to the smallest runnable command and fill them in first (focus on `--project_id`, `--event_name`, and `--event_desc`).
|
|
56
|
-
- If `Invalid JSON` appears, first check required fields, then verify whether the event and property names come from metadata query results in the same `project_id`.
|
|
57
|
-
- If the result after writing does not match expectations, immediately reread the corresponding list/get interfaces for before-and-after comparison.
|
|
58
|
-
|
|
59
|
-
## Recommended Chaining
|
|
60
|
-
- +list_events -> +create_virtual_event
|
|
@@ -1,69 +0,0 @@
|
|
|
1
|
-
# analysis_meta +create_virtual_property (Create Virtual Property)
|
|
2
|
-
|
|
3
|
-
> **Prerequisite:** Follow the Global AE CLI Rules in [`../SKILL.md`](../SKILL.md).
|
|
4
|
-
|
|
5
|
-
Domain: **Metadata Query**
|
|
6
|
-
|
|
7
|
-
## Use Cases
|
|
8
|
-
- Before creating a virtual property, first confirm the available properties and, as needed, available events from the project metadata.
|
|
9
|
-
- Create a SQL-based virtual property.
|
|
10
|
-
- A SQL virtual property is a computed property defined by a SQL expression.
|
|
11
|
-
- Key parameters:
|
|
12
|
-
- propertyName: Unique name for the virtual property (must start with '#vp@'), the name after '#vp@' must start with a letter, and can contain letters, numbers and underscores, with a maximum of 60 characters.
|
|
13
|
-
- propertyDesc: Display name/description
|
|
14
|
-
- tableType: event or user. Determine based on the prompt whether to create a virtual event property or a virtual user property
|
|
15
|
-
- selectType: Data type (string, number, bool, datetime)
|
|
16
|
-
- sqlExpression: SQL expression for computing the property
|
|
17
|
-
- sqlEventRelationType: relation_default, relation_always, or relation_by_setting
|
|
18
|
-
|
|
19
|
-
## Mandatory Prerequisites (MUST)
|
|
20
|
-
- Before building `--sql_expression` / `--related_events`, you must first read and follow the reference docs below:
|
|
21
|
-
- [`./list_properties.md`](./list_properties.md)
|
|
22
|
-
- [`./list_events.md`](./list_events.md) (only when `sql_event_relation_type=relation_by_setting`)
|
|
23
|
-
- Do not submit the final SQL and event-association configuration until the above docs have been read and the prerequisite commands have been run.
|
|
24
|
-
|
|
25
|
-
## Prerequisite Call Chain (required for building SQL and relations)
|
|
26
|
-
1. Read `list_properties.md`, then run `ae-cli analysis_meta +list_properties --project_id <project_id>` to get the available properties.
|
|
27
|
-
2. Use `--table_type` to determine the SQL field source (event or user scope).
|
|
28
|
-
3. Write `--sql_expression` using only fields confirmed in the previous step; the expression must conform to Trino syntax.
|
|
29
|
-
4. If `--sql_event_relation_type=relation_by_setting`, read `list_events.md`, then run `ae-cli analysis_meta +list_events --project_id <project_id>` to get the available events and build `--related_events`.
|
|
30
|
-
5. Call `+create_virtual_property` to create the virtual property.
|
|
31
|
-
6. Example `sql_expression`: `property_a + property_b` or `CASE WHEN status = 1 THEN 'active' ELSE 'inactive' END`.
|
|
32
|
-
|
|
33
|
-
## Command
|
|
34
|
-
```bash
|
|
35
|
-
ae-cli analysis_meta +create_virtual_property --project_id <project_id> --property_name '#vp@demo' --table_type event --select_type string --sql_expression 'event_name' --sql_event_relation_type relation_default
|
|
36
|
-
ae-cli analysis_meta +create_virtual_property --project_id <project_id> --property_name '#vp@demo' --property_desc demo --table_type event --select_type string --sql_expression "CASE WHEN status = 1 THEN 'active' ELSE 'inactive' END" --sql_event_relation_type relation_by_setting --related_events '[{"eventName":"purchase"}]' --property_remark demo
|
|
37
|
-
ae-cli analysis_meta +create_virtual_property --dry-run
|
|
38
|
-
```
|
|
39
|
-
|
|
40
|
-
## Parameters
|
|
41
|
-
| Parameter | Required | Description |
|
|
42
|
-
|---|---|---|
|
|
43
|
-
| `--project_id` / `-p` | Yes | Project ID |
|
|
44
|
-
| `--property_name` | Yes | Name for the virtual property (must start with '#vp@'), the name after '#vp@' must start with a letter, and can contain letters, numbers and underscores, with a maximum of 60 characters. |
|
|
45
|
-
| `--property_desc` | No | Display name/description |
|
|
46
|
-
| `--table_type` | Yes | Table type. event: create virtual event property(virtual property generated based on event or user properties), user: create virtual user property(virtual property generated based on user properties) |
|
|
47
|
-
| `--select_type` | Yes | Data type: string, number, bool, datetime |
|
|
48
|
-
| `--sql_expression` | Yes | SQL expression for computing the property. MUST be built from fields confirmed by `analysis_meta +list_properties` in the same `project_id`, and MUST conform to Trino syntax (for example, columns starting with '#' or containing '@' should be double-quoted). |
|
|
49
|
-
| `--sql_event_relation_type` | Yes | Type of associating attributes with events, relation_default: auto; relation_always: all events; relation_by_setting: specified events |
|
|
50
|
-
| `--related_events` | No | Optional JSON array of related events. When `sql_event_relation_type=relation_by_setting`, this field is required and event names MUST come from `analysis_meta +list_events` in the same `project_id`. |
|
|
51
|
-
| `--property_remark` | No | Optional property remark |
|
|
52
|
-
|
|
53
|
-
## Decision Rules
|
|
54
|
-
- `sql_expression` / `related_events` cannot be written from experience alone: they must be built from real project metadata.
|
|
55
|
-
- `list_properties` / `list_events` must be read before their corresponding commands are run.
|
|
56
|
-
- First run should only pass required parameters (`--project_id`, `--property_name`, `--table_type`, `--select_type`, `--sql_expression`, `--sql_event_relation_type`), and add optional parameters only after the path is confirmed to work.
|
|
57
|
-
- Wrap JSON arguments in single quotes (for example `--related_events '{}'`) to avoid shell escaping issues.
|
|
58
|
-
- For cross-project troubleshooting, first confirm whether `--project_id` matches the current permissions and target environment.
|
|
59
|
-
- This is an ordinary `write` operation and does not require CLI confirmation.
|
|
60
|
-
|
|
61
|
-
## Next Steps After Failure
|
|
62
|
-
- If required parameters are missing, fall back to the smallest runnable command and fill them in (focus on `--project_id`, `--property_name`, and `--table_type`).
|
|
63
|
-
- If `Invalid JSON` occurs, first check the `related_events` structure, then verify whether the event names came from the `list_events` result for the same `project_id`.
|
|
64
|
-
- If SQL execution or validation fails, first check whether the field names came from `list_properties`, then check whether the Trino syntax and field references are correct.
|
|
65
|
-
- If the result after writing is not as expected, immediately read back the corresponding list/get interface for a before-and-after comparison.
|
|
66
|
-
|
|
67
|
-
## Recommended Chaining
|
|
68
|
-
- +list_properties -> +create_virtual_property
|
|
69
|
-
- +list_properties -> +list_events -> +create_virtual_property (sql_event_relation_type=relation_by_setting)
|
|
@@ -1,32 +0,0 @@
|
|
|
1
|
-
# analysis_meta +delete_metric (Delete Metric)
|
|
2
|
-
|
|
3
|
-
> **Prerequisite:** Follow the Global AE CLI Rules in [`../SKILL.md`](../SKILL.md).
|
|
4
|
-
|
|
5
|
-
Domain: **Metric Management**
|
|
6
|
-
|
|
7
|
-
## Use Cases
|
|
8
|
-
- Permanently delete a metric by its ID.
|
|
9
|
-
- Do not use it when the metric should be retained with a corrected definition; use `+update_metric` instead.
|
|
10
|
-
|
|
11
|
-
## Output
|
|
12
|
-
Success confirms deletion of the specified metric. The command does not return a metric definition; verify absence with `+list_metrics`.
|
|
13
|
-
|
|
14
|
-
## Commands
|
|
15
|
-
```bash
|
|
16
|
-
ae-cli analysis_meta +delete_metric --project_id <project_id> --metric_id <metric_id> --dry-run
|
|
17
|
-
# Summarize the target and impact, then wait for explicit user confirmation.
|
|
18
|
-
ae-cli analysis_meta +delete_metric --project_id <project_id> --metric_id <metric_id> --yes
|
|
19
|
-
```
|
|
20
|
-
|
|
21
|
-
## Parameters
|
|
22
|
-
| Parameter | Required | Description |
|
|
23
|
-
|---|---|---|
|
|
24
|
-
| `--project_id` / `-p` | Yes | Project ID |
|
|
25
|
-
| `--metric_id` | Yes | Metric ID to delete |
|
|
26
|
-
|
|
27
|
-
## Decision Rules
|
|
28
|
-
- Use `+list_metrics` first to confirm the metric ID before deleting.
|
|
29
|
-
- This is `high-risk-write`: inspect the dry-run, summarize the target and impact, and wait for explicit user confirmation before the `--yes` execution.
|
|
30
|
-
|
|
31
|
-
## Recommended Chain
|
|
32
|
-
- `+list_metrics` -> `+delete_metric`
|
|
@@ -1,17 +0,0 @@
|
|
|
1
|
-
# analysis drilldown-users export
|
|
2
|
-
|
|
3
|
-
Export all users for a selected result target from a previous analysis query context. Do not pass raw QP.
|
|
4
|
-
|
|
5
|
-
## Command
|
|
6
|
-
|
|
7
|
-
```bash
|
|
8
|
-
ae-cli analysis drilldown-users export \
|
|
9
|
-
--query-context-id <query_context_id> \
|
|
10
|
-
--target '<json>' \
|
|
11
|
-
[--artifact-format jsonl] \
|
|
12
|
-
[--timeout-seconds 21600]
|
|
13
|
-
```
|
|
14
|
-
|
|
15
|
-
Use the same `query_context_id`, `target`, and optional `properties` contract as `analysis drilldown-users run`. Export does not accept `--limit` or `--offset`; Common reads backend batches internally and writes one JSONL artifact.
|
|
16
|
-
|
|
17
|
-
Inspect the returned `run_id` with `analysis run inspect`, then download the completed artifact with `analysis artifact download`. The final metadata line includes `rows`, `total`, and `drilldown_context_id`.
|
|
@@ -1,61 +0,0 @@
|
|
|
1
|
-
# analysis drilldown-users run
|
|
2
|
-
|
|
3
|
-
Precondition: the upstream response must have `drilldown_available=true` and the selected source must contain `target_contract`. If either is absent, do not call this command or reconstruct a target from display text.
|
|
4
|
-
|
|
5
|
-
Drill down to users from a previous analysis data query context.
|
|
6
|
-
|
|
7
|
-
Use this after any analysis data command that returns `query_context_id`:
|
|
8
|
-
|
|
9
|
-
- `analysis adhoc run`
|
|
10
|
-
- `analysis adhoc export`
|
|
11
|
-
- `analysis report-data run`
|
|
12
|
-
- `analysis report-data export`
|
|
13
|
-
- `analysis dashboard-report-data run`
|
|
14
|
-
- `analysis dashboard-report-data export`
|
|
15
|
-
|
|
16
|
-
Do not pass raw QP.
|
|
17
|
-
|
|
18
|
-
## Command
|
|
19
|
-
|
|
20
|
-
```bash
|
|
21
|
-
ae-cli analysis drilldown-users run \
|
|
22
|
-
--query-context-id <query_context_id> \
|
|
23
|
-
--target '<json>' \
|
|
24
|
-
[--limit 100] \
|
|
25
|
-
[--timeout-seconds 120]
|
|
26
|
-
```
|
|
27
|
-
|
|
28
|
-
## Input
|
|
29
|
-
|
|
30
|
-
- `--query-context-id`: returned by an analysis data run/export submit response, or by the first metadata line of a JSONL artifact.
|
|
31
|
-
- `--target`: pass the selected source's `target_contract.default_target` directly for the whole-result default. For a specific result row or cell, copy that object and replace only the fields named by `target_contract.copy_from_selected_result`.
|
|
32
|
-
- `--properties`: optional backend property request object array. Omit this in normal agent calls and use the default returned columns. Do not pass string-name arrays such as `["#user_id"]`.
|
|
33
|
-
|
|
34
|
-
Do not use raw QP or reconstruct the first query request. The server resolves the source QP from Redis by `query_context_id`.
|
|
35
|
-
|
|
36
|
-
## Target
|
|
37
|
-
|
|
38
|
-
`--target` identifies the cell/step/bucket/date to drill down. The upstream `sources[]` entry is the machine-readable contract. Do not infer a target shape from model memory or reuse a target from a different source/model.
|
|
39
|
-
|
|
40
|
-
`target_contract.default_target` already contains `report_id` or `chart_id` when needed. Preserve it unchanged:
|
|
41
|
-
|
|
42
|
-
```json
|
|
43
|
-
{"report_id":1001,"drilldown_date":"2026-07-01","drilldown_groups":["ios"],"event_index":0}
|
|
44
|
-
```
|
|
45
|
-
|
|
46
|
-
Common fields:
|
|
47
|
-
|
|
48
|
-
- `report_id`: required when the context contains multiple report sources.
|
|
49
|
-
- `chart_id`: required when the context contains multiple BI chart sources. BI SQL chart contexts normally return `drilldown_available=false`; do not call drilldown unless the first response explicitly says `drilldown_available=true`.
|
|
50
|
-
- `drilldown_date` or `target_dates`: target date(s) from the result row. Include one of these when you plan to call `drilldown-user-events` next; `include_total` alone can list users but may not carry enough date context for event-sequence lookup.
|
|
51
|
-
- `drilldown_groups`: group values from the result row.
|
|
52
|
-
- `event_index`: event model index, starting from 0.
|
|
53
|
-
- `retention_days`, `is_lost`: retention target.
|
|
54
|
-
- `funnel_step`, `is_churned_user`: funnel target.
|
|
55
|
-
- `interval`, `distribution_bucket`, `compare_index`, `include_total`, `relation_val`: model-specific target fields.
|
|
56
|
-
|
|
57
|
-
## Output
|
|
58
|
-
|
|
59
|
-
The response contains at most `limit` user rows and a `drilldown_context_id`. When `truncated=true`, use `analysis drilldown-users export`; do not attempt to fetch another page.
|
|
60
|
-
|
|
61
|
-
Use `drilldown_context_id` with `analysis drilldown-user-events run` or `analysis drilldown-user-events export`.
|
|
@@ -1,38 +0,0 @@
|
|
|
1
|
-
# analysis_meta +get_metric (View Metric Details)
|
|
2
|
-
|
|
3
|
-
> **Prerequisite:** Follow the Global AE CLI Rules in [`../SKILL.md`](../SKILL.md).
|
|
4
|
-
|
|
5
|
-
Domain: **Metadata Query**
|
|
6
|
-
|
|
7
|
-
## Constraints
|
|
8
|
-
|
|
9
|
-
**Not an ad-hoc pre-step:** Do not call `+get_metric` just to expand a saved metric before normal ad-hoc analysis. If the user asks to query a saved metric, pass the metric display/name/remark directly in `analysis adhoc run --definition`; the backend compiler resolves saved metrics internally.
|
|
10
|
-
|
|
11
|
-
## Use Cases
|
|
12
|
-
- Get the definition details of a single metric. Returns the metric name, display name, remark, model type, linked events, and parameter definition without executing metric calculation.
|
|
13
|
-
- Use this command for metric metadata inspection, metric editing, auditing, or when the user explicitly asks for metric definition details. Do not use it merely to expand a saved metric before an ad-hoc query.
|
|
14
|
-
|
|
15
|
-
## Commands
|
|
16
|
-
```bash
|
|
17
|
-
ae-cli analysis_meta +get_metric --project_id <project_id> --metric_id 1
|
|
18
|
-
ae-cli analysis_meta +get_metric --dry-run
|
|
19
|
-
```
|
|
20
|
-
|
|
21
|
-
## Parameters
|
|
22
|
-
| Parameter | Required | Description |
|
|
23
|
-
|---|---|---|
|
|
24
|
-
| `--project_id` / `-p` | Yes | Project ID |
|
|
25
|
-
| `--metric_id` / `-m` | Yes | Metric ID |
|
|
26
|
-
|
|
27
|
-
## Decision Rules
|
|
28
|
-
- For the first run, pass only the required parameters (`--project_id` and `--metric_id`) to confirm the path works, then add optional parameters.
|
|
29
|
-
- For ad-hoc analysis, do not read metric details first. Call `analysis adhoc run` or `analysis adhoc export` with the user's metric/event/property wording.
|
|
30
|
-
- For cross-project troubleshooting, first confirm whether `--project_id` matches the current permissions and target environment.
|
|
31
|
-
|
|
32
|
-
## Next Steps After Failure
|
|
33
|
-
- If required parameters are missing, fall back to the smallest runnable command and fill them in first (focus on `--project_id` and `--metric_id`).
|
|
34
|
-
- If reading fails, first verify that the object ID exists and belongs to the current project.
|
|
35
|
-
|
|
36
|
-
## Recommended Chaining
|
|
37
|
-
- +get_metric -> +update_metric
|
|
38
|
-
- For ad-hoc saved metric query: analysis adhoc run/export
|
|
@@ -1,33 +0,0 @@
|
|
|
1
|
-
# Resource link completion (call analysis_common +get_resource_url)
|
|
2
|
-
|
|
3
|
-
> **Prerequisite:** Follow the Global AE CLI Rules in [`../SKILL.md`](../SKILL.md).
|
|
4
|
-
|
|
5
|
-
Domain: **cross-module post-write constraint**
|
|
6
|
-
|
|
7
|
-
## Use Cases
|
|
8
|
-
- After a `create_*` or `update_*` write operation succeeds in this unified skill, complete the clickable asset link.
|
|
9
|
-
- Supported resource types (resourceType): `dashboard`, `report`, `metric`, `alert`, `tag`, `cluster`, `data_table`, `super_event`, `super_prop_user`, `super_prop_event`, `virtual_event`, `user_virtual_prop`, `event_virtual_prop`.
|
|
10
|
-
- Key return fields: `markdown_link`, `raw_url`.
|
|
11
|
-
|
|
12
|
-
## Mandatory Rules (MUST)
|
|
13
|
-
- As long as `project_id + resource_type + resource_id` can be determined, this command must be called.
|
|
14
|
-
- The final response must output `markdown_link` directly (do not place it in a code block) so the user can click through.
|
|
15
|
-
- If resource link generation fails, keep the main write-operation success conclusion and add the failure reason.
|
|
16
|
-
|
|
17
|
-
## Command
|
|
18
|
-
```bash
|
|
19
|
-
ae-cli analysis_common +get_resource_url --project_id <project_id> --resource_type dashboard --resource_id 1
|
|
20
|
-
ae-cli analysis_common +get_resource_url --dry-run
|
|
21
|
-
```
|
|
22
|
-
|
|
23
|
-
## Parameters
|
|
24
|
-
| Parameter | Required | Description |
|
|
25
|
-
|---|---|---|
|
|
26
|
-
| `--project_id` / `-p` | Yes | Project ID |
|
|
27
|
-
| `--resource_type` | Yes | Resource type: dashboard/report/metric/alert/tag/cluster/data_table/super_event/super_prop_user/super_prop_event/virtual_event/user_virtual_prop/event_virtual_prop |
|
|
28
|
-
| `--resource_id` | Yes | Numeric resource ID |
|
|
29
|
-
|
|
30
|
-
## Recommended Chaining
|
|
31
|
-
- `+create_*` -> `analysis_common +get_resource_url`
|
|
32
|
-
- `+update_*` -> `analysis_common +get_resource_url`
|
|
33
|
-
- For `analysis report create/update`, use the returned `report_id` directly as `--resource_id`; do not run a broad report list to rediscover the asset.
|
|
@@ -1,46 +0,0 @@
|
|
|
1
|
-
# analysis_meta +list_events (Event Metadata Discovery)
|
|
2
|
-
|
|
3
|
-
> **Prerequisite:** Follow the Global AE CLI Rules in [`../SKILL.md`](../SKILL.md).
|
|
4
|
-
|
|
5
|
-
Domain: **Metadata Query**
|
|
6
|
-
|
|
7
|
-
## Constraints
|
|
8
|
-
|
|
9
|
-
**Fuzzy Search Fallback:** If `--query` returns no results, retry with broader keywords (max 3 attempts), then fall back to full list. See [SKILL.md § C. FUZZY_SEARCH_FALLBACK](../SKILL.md#c-fuzzy_search_fallback).
|
|
10
|
-
|
|
11
|
-
**Not an ad-hoc pre-step:** Do not call `+list_events` just to prepare `analysis adhoc run/export`. Pass the user's event wording in the AI-facing `definition`; the backend compiler resolves it or returns a structured clarification/error. Use this command only when the user explicitly wants to inspect metadata or when a prior compiler error asks for disambiguation.
|
|
12
|
-
|
|
13
|
-
## Use Cases
|
|
14
|
-
- Read-only query for SYSTEM METADATA already effective in the project. Use for super events in production metadata. Do NOT use for tracking-plan metadata (bury/track program); that belongs to BuryProgramTool.
|
|
15
|
-
- Read-only query for SYSTEM METADATA already effective in the project. Use when the user explicitly asks to inspect event metadata, not as a required preparation step for ad-hoc AI model construction.
|
|
16
|
-
|
|
17
|
-
## Commands
|
|
18
|
-
```bash
|
|
19
|
-
ae-cli analysis_meta +list_events --project_id <project_id>
|
|
20
|
-
ae-cli analysis_meta +list_events --project_id <project_id> --query demo
|
|
21
|
-
ae-cli analysis_meta +list_events --project_id <project_id> --query demo --fields '["eventId", "eventName", "eventDesc", "remark"]' --limit 50 --offset 0
|
|
22
|
-
ae-cli analysis_meta +list_events --dry-run
|
|
23
|
-
```
|
|
24
|
-
|
|
25
|
-
## Parameters
|
|
26
|
-
| Parameter | Required | Description |
|
|
27
|
-
|---|---|---|
|
|
28
|
-
| `--project_id` / `-p` | Yes | Project ID |
|
|
29
|
-
| `--query` / `-q` | No | Optional keyword filter. Performs fuzzy matching against eventName, eventDesc, and remark; if omitted, all events are returned. |
|
|
30
|
-
| `--fields` / `-f` | No | Optional fields to return (JSON array). Supported fields: `eventId`, `eventName`, `eventDesc`, `remark`, `eventTag`, `authenticationStatus`. Default fields when omitted: `eventId`, `eventName`, `eventDesc`, `remark`, `authenticationStatus`. |
|
|
31
|
-
| `--limit` / `-l` | No | Optional page size. Default: 50, maximum: 200. |
|
|
32
|
-
| `--offset` / `-o` | No | Optional page offset. Default: 0. |
|
|
33
|
-
| `--authenticated_only` | No | When true, return only authenticated events. |
|
|
34
|
-
|
|
35
|
-
## Decision Rules
|
|
36
|
-
- Use `--authenticated_only true` only when the user explicitly asks for authenticated assets. `authenticationStatus` is `1` for authenticated and `0` for unauthenticated.
|
|
37
|
-
- For the first run, pass only the required parameter (`--project_id`) to confirm the path works, then add optional parameters.
|
|
38
|
-
- For ad-hoc analysis, pass the user's event wording in the AI-facing `definition` instead of pre-querying event metadata.
|
|
39
|
-
- For cross-project troubleshooting, first confirm whether `--project_id` matches the current permissions and target environment.
|
|
40
|
-
|
|
41
|
-
## Next Steps After Failure
|
|
42
|
-
- If required parameters are missing, fall back to the smallest runnable command and fill them in first (focus on `--project_id`).
|
|
43
|
-
- If the result is empty, first confirm the project ID/keyword, then try loosening the filter conditions.
|
|
44
|
-
|
|
45
|
-
## Recommended Chaining
|
|
46
|
-
- +list_events -> +create_virtual_event
|
|
@@ -1,52 +0,0 @@
|
|
|
1
|
-
# analysis_meta +list_metrics (Metric Search)
|
|
2
|
-
|
|
3
|
-
> **Prerequisite:** Follow the Global AE CLI Rules in [`../SKILL.md`](../SKILL.md).
|
|
4
|
-
|
|
5
|
-
Domain: **Metadata Query**
|
|
6
|
-
|
|
7
|
-
## Constraints
|
|
8
|
-
|
|
9
|
-
**Fuzzy Search Fallback:** If `--query` returns no results, retry with broader keywords (max 3 attempts), then fall back to full list. See [SKILL.md § C. FUZZY_SEARCH_FALLBACK](../SKILL.md#c-fuzzy_search_fallback).
|
|
10
|
-
|
|
11
|
-
**Not an ad-hoc pre-step:** Do not call `+list_metrics` just to prepare normal ad-hoc analysis. Pass the saved metric wording directly in `analysis adhoc run/export --definition`; the backend compiler resolves saved metric names internally. If compilation fails, stop and ask for clarification instead of using this command as a fallback.
|
|
12
|
-
|
|
13
|
-
## Use Cases
|
|
14
|
-
- List metric metadata in the project. Supports keyword filtering and returns metric IDs, names, display names, model types, remarks, and related metadata, but not metric calculation results.
|
|
15
|
-
- Supports pagination with fields/limit/offset for payload governance.
|
|
16
|
-
- Query performs fuzzy matching on metricName, metricDesc, and metricRemark.
|
|
17
|
-
- Use this command for metric metadata management, metric editing, auditing, or when the user explicitly asks to inspect/search metric metadata. Do not use it merely to prepare an ad-hoc query.
|
|
18
|
-
|
|
19
|
-
## Command
|
|
20
|
-
```bash
|
|
21
|
-
ae-cli analysis_meta +list_metrics --project_id <project_id>
|
|
22
|
-
ae-cli analysis_meta +list_metrics --project_id <project_id> --query demo
|
|
23
|
-
ae-cli analysis_meta +list_metrics --project_id <project_id> --query demo --fields '["metricId","metricName","metricDesc","metricRemark","metricMode"]' --limit 10 --offset 0
|
|
24
|
-
ae-cli analysis_meta +list_metrics --dry-run
|
|
25
|
-
```
|
|
26
|
-
|
|
27
|
-
## Parameters
|
|
28
|
-
| Parameter | Required | Description |
|
|
29
|
-
|---|---|---|
|
|
30
|
-
| `--project_id` / `-p` | Yes | Project ID |
|
|
31
|
-
| `--query` / `-q` | No | Optional keyword filter. Fuzzy match on metricName, metricDesc, metricRemark. |
|
|
32
|
-
| `--fields` | No | Optional fields to return. Supported: metricId, metricName, metricDesc, metricRemark, metricMode, authenticationStatus, openId, creator, creatorLoginName, updateOpenId, updateCreator, updateLoginName, createTime, updateTime. Default fields when omitted: metricId, metricName, metricDesc, metricRemark, metricMode, authenticationStatus. Invalid fields cause INVALID_FIELDS error. |
|
|
33
|
-
| `--limit` | No | Optional limit. Default: 50, maximum: 200. |
|
|
34
|
-
| `--offset` | No | Optional offset. Default: 0. |
|
|
35
|
-
| `--authenticated_only` | No | When true, return only authenticated metrics. |
|
|
36
|
-
|
|
37
|
-
## Decision Rules
|
|
38
|
-
- Use `--authenticated_only true` only when the user explicitly asks for authenticated assets. `authenticationStatus` is `1` for authenticated and `0` for unauthenticated.
|
|
39
|
-
- First run should only pass the required parameter (`--project_id`), and add optional parameters only after the path is confirmed to work.
|
|
40
|
-
- For pagination, use `--limit` and `--offset` together. Default limit is 20.
|
|
41
|
-
- Use `--fields` to select specific columns for lighter response payloads.
|
|
42
|
-
- For ad-hoc analysis, do not search metrics here first. Pass the user-provided metric name directly to `analysis adhoc run/export`.
|
|
43
|
-
- For cross-project troubleshooting, first confirm whether `--project_id` matches the current permissions and target environment.
|
|
44
|
-
|
|
45
|
-
## Next Steps After Failure
|
|
46
|
-
- If the required parameter is missing, fall back to the smallest runnable command and fill it in (focus on `--project_id`).
|
|
47
|
-
- If the result is empty, first confirm the project ID/keyword, then try loosening the filter conditions.
|
|
48
|
-
- If INVALID_FIELDS error appears, check that all field names in `--fields` match the supported list.
|
|
49
|
-
|
|
50
|
-
## Recommended Chaining
|
|
51
|
-
- +list_metrics -> +create_metric -> +get_metric
|
|
52
|
-
- For ad-hoc event metric query: analysis adhoc run/export
|
|
@@ -1,47 +0,0 @@
|
|
|
1
|
-
# analysis_meta +list_properties (Property Metadata Discovery)
|
|
2
|
-
|
|
3
|
-
> **Prerequisite:** Follow the Global AE CLI Rules in [`../SKILL.md`](../SKILL.md).
|
|
4
|
-
|
|
5
|
-
Domain: **Metadata Query**
|
|
6
|
-
|
|
7
|
-
## Constraints
|
|
8
|
-
|
|
9
|
-
**Not an ad-hoc pre-step:** Do not call `+list_properties` just to prepare `analysis adhoc run/export`. Pass the user's property wording in the AI-facing `definition`; the backend compiler resolves it or returns a structured clarification/error. Use this command only when the user explicitly wants to inspect metadata or when a prior compiler error asks for disambiguation.
|
|
10
|
-
|
|
11
|
-
## Use Cases
|
|
12
|
-
- Read-only query for SYSTEM METADATA properties already effective in the project. Supports event/user scope. Do NOT use for tracking-plan metadata (bury/track program); that belongs to BuryProgramTool.
|
|
13
|
-
- Read-only query for SYSTEM METADATA properties already effective in the project. Use when the user explicitly asks to inspect property metadata, not as a required preparation step for ad-hoc AI model construction.
|
|
14
|
-
|
|
15
|
-
## Commands
|
|
16
|
-
```bash
|
|
17
|
-
ae-cli analysis_meta +list_properties --project_id <project_id>
|
|
18
|
-
ae-cli analysis_meta +list_properties --project_id <project_id> --scope event --event_name purchase --query demo
|
|
19
|
-
ae-cli analysis_meta +list_properties --project_id <project_id> --query demo --fields '["propId", "propName", "propDesc", "remark", "selectType", "tableType"]' --limit 50 --offset 0
|
|
20
|
-
ae-cli analysis_meta +list_properties --dry-run
|
|
21
|
-
```
|
|
22
|
-
|
|
23
|
-
## Parameters
|
|
24
|
-
| Parameter | Required | Description |
|
|
25
|
-
|---|---|---|
|
|
26
|
-
| `--project_id` / `-p` | Yes | Project ID |
|
|
27
|
-
| `--scope` | No | Optional property scope. event means event properties, user means user properties. If omitted, all scopes are queried. |
|
|
28
|
-
| `--event_name` | No | Optional event name. If provided, only event properties available for that event are returned. |
|
|
29
|
-
| `--query` / `-q` | No | Optional keyword filter. Fuzzy match is applied to propName, propDesc, and remark; if omitted, all matched properties are returned. |
|
|
30
|
-
| `--fields` / `-f` | No | Optional fields to return (JSON array). Supported fields: `propId`, `propName`, `propDesc`, `remark`, `selectType`, `tableType`, `subTableType`, `authenticationStatus`. Default fields when omitted: `propId`, `propName`, `propDesc`, `remark`, `selectType`, `tableType`, `authenticationStatus`. |
|
|
31
|
-
| `--limit` / `-l` | No | Optional page size. Default: 50, maximum: 200. |
|
|
32
|
-
| `--offset` / `-o` | No | Optional page offset. Default: 0. |
|
|
33
|
-
| `--authenticated_only` | No | When true, return only authenticated properties. |
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
## Decision Rules
|
|
37
|
-
- Use `--authenticated_only true` only when the user explicitly asks for authenticated assets. `authenticationStatus` is `1` for authenticated and `0` for unauthenticated.
|
|
38
|
-
- For the first run, pass only the required parameter (`--project_id`) to confirm the path works, then add optional parameters.
|
|
39
|
-
- For ad-hoc analysis, pass the user's property wording in the AI-facing `definition` instead of pre-querying property metadata.
|
|
40
|
-
- For cross-project troubleshooting, first confirm whether `--project_id` matches the current permissions and target environment.
|
|
41
|
-
|
|
42
|
-
## Next Steps After Failure
|
|
43
|
-
- If required parameters are missing, fall back to the smallest runnable command and fill them in first (focus on `--project_id`).
|
|
44
|
-
- If the result is empty, first confirm the project ID/keyword, then try loosening the filter conditions.
|
|
45
|
-
|
|
46
|
-
## Recommended Chaining
|
|
47
|
-
- +list_properties -> +create_virtual_property
|
|
@@ -1,58 +0,0 @@
|
|
|
1
|
-
# analysis_meta +update_metric (Update Metric)
|
|
2
|
-
|
|
3
|
-
> **Prerequisite:** Follow the Global AE CLI Rules in [`../SKILL.md`](../SKILL.md).
|
|
4
|
-
|
|
5
|
-
Domain: **Metadata Query**
|
|
6
|
-
|
|
7
|
-
## Use Cases
|
|
8
|
-
- Before updating `events` / `params`, you must supplement the payload with real event/property metadata.
|
|
9
|
-
- Update a metric definition. Currently only the event and retention models are supported. Returns the updated metric information without executing metric calculation.
|
|
10
|
-
- Update a metric definition.
|
|
11
|
-
|
|
12
|
-
## MUST Prerequisites
|
|
13
|
-
- Before updating `--events` / `--params`, you must first read and follow these reference documents:
|
|
14
|
-
- [`./list_events.md`](./list_events.md)
|
|
15
|
-
- [`./list_properties.md`](./list_properties.md)
|
|
16
|
-
- Do not submit new `events` / `params` until the document review and prerequisite command calls above are complete.
|
|
17
|
-
|
|
18
|
-
## Prerequisite Call Chain (Required for Updating events/params)
|
|
19
|
-
1. Determine `--model_type` first (`event` / `retention`).
|
|
20
|
-
2. Read `list_events.md`, then call `ae-cli analysis_meta +list_events --project_id <project_id>`.
|
|
21
|
-
3. Read `list_properties.md`, then call `ae-cli analysis_meta +list_properties --project_id <project_id>`.
|
|
22
|
-
4. Build the new `events` / `params` from the metric API payload shape and verified metadata, then execute `+update_metric`.
|
|
23
|
-
|
|
24
|
-
## Commands
|
|
25
|
-
```bash
|
|
26
|
-
ae-cli analysis_meta +update_metric --project_id <project_id> --metric_id 1 --name demo --display_name demo --model_type event --events '[]'
|
|
27
|
-
ae-cli analysis_meta +update_metric --project_id <project_id> --metric_id 1 --name demo --display_name demo --remark demo --model_type event --events '[]' --params '{}'
|
|
28
|
-
ae-cli analysis_meta +update_metric --dry-run
|
|
29
|
-
```
|
|
30
|
-
|
|
31
|
-
## Parameters
|
|
32
|
-
| Parameter | Required | Description |
|
|
33
|
-
|---|---|---|
|
|
34
|
-
| `--project_id` / `-p` | Yes | Project ID |
|
|
35
|
-
| `--metric_id` / `-m` | Yes | Metric ID |
|
|
36
|
-
| `--name` | Yes | Metric name. Must start with a lowercase letter and contain only lowercase letters, digits, and underscores. Maximum length: 80. |
|
|
37
|
-
| `--display_name` | Yes | Metric display name |
|
|
38
|
-
| `--remark` | No | Optional metric remark |
|
|
39
|
-
| `--model_type` | Yes | Metric model type. Currently supports event and retention. |
|
|
40
|
-
| `--events` | Yes | Metric event JSON. Use fields validated by `analysis_meta +list_events` / `analysis_meta +list_properties` in the same `project_id`. |
|
|
41
|
-
| `--params` | No | Metric params JSON. If provided, use project metadata from `analysis_meta +list_events` / `analysis_meta +list_properties`. |
|
|
42
|
-
|
|
43
|
-
## Decision Rules
|
|
44
|
-
- `events` / `params` must not be handwritten by intuition alone: they must satisfy the metric API payload shape and the project's real metadata constraints.
|
|
45
|
-
- Set `--model_type` first, then use the matching schema; do not mix event/retention structures.
|
|
46
|
-
- Before calling `list_events` / `list_properties`, you must first study the corresponding reference documents.
|
|
47
|
-
- The smallest valid request still requires `--project_id`, `--metric_id`, `--name`, `--display_name`, `--model_type`, and `--events`; do not omit the new definition to “test the path.” Use `--dry-run` with the complete request for preflight.
|
|
48
|
-
- Wrap JSON parameters in single quotes (for example `--events '{}'` and `--params '{}'`) to avoid shell escaping issues.
|
|
49
|
-
- For cross-project troubleshooting, first confirm whether `--project_id` matches the current permissions and target environment.
|
|
50
|
-
- This is an ordinary `write` operation and does not require CLI confirmation.
|
|
51
|
-
|
|
52
|
-
## Next Steps After Failure
|
|
53
|
-
- If required parameters are missing, complete all required fields listed above before retrying.
|
|
54
|
-
- If `Invalid JSON` appears, first check required fields, then verify whether the event and property names come from metadata query results in the same `project_id`.
|
|
55
|
-
- If the result after writing does not match expectations, immediately reread the corresponding list/get interfaces for before-and-after comparison.
|
|
56
|
-
|
|
57
|
-
## Recommended Chaining
|
|
58
|
-
- +list_metrics -> +get_metric -> +update_metric
|
|
@@ -18,13 +18,13 @@ function findGatewayDomain(cliService) {
|
|
|
18
18
|
return cliServiceRoutes.get(cliService)?.gatewayDomain;
|
|
19
19
|
}
|
|
20
20
|
function resolveGatewayDomain(cliService, override) {
|
|
21
|
-
if (override !== void 0) {
|
|
22
|
-
return override;
|
|
23
|
-
}
|
|
24
21
|
const envDomain = envGatewayDomain(cliService);
|
|
25
22
|
if (envDomain !== void 0) {
|
|
26
23
|
return envDomain;
|
|
27
24
|
}
|
|
25
|
+
if (override !== void 0) {
|
|
26
|
+
return override;
|
|
27
|
+
}
|
|
28
28
|
const route = cliServiceRoutes.get(cliService);
|
|
29
29
|
if (!route) {
|
|
30
30
|
throw new Error(
|