@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.
Files changed (192) hide show
  1. package/README.md +3 -2
  2. package/README.zh.md +3 -2
  3. package/dist/{capability-SQ2IWKP3.js → capability-QW4AVJHI.js} +1 -1
  4. package/dist/{capability-SEH3JWLN.js → capability-SCRFGODD.js} +1 -1
  5. package/dist/{chunk-N2QORU5D.js → chunk-7OLGDQQ2.js} +5 -2
  6. package/dist/{chunk-TKQJQXWT.js → chunk-TBHBYKXZ.js} +5 -2
  7. package/dist/index.js +51 -24
  8. package/dist/{metadata-X62TKIVK.js → metadata-BFDL6RUK.js} +2 -2
  9. package/dist/{metadata-W6JFFMBA.js → metadata-FCLDBXX2.js} +2 -2
  10. package/dist/{te-analysis-NJGNWZFC.js → te-analysis-PUVF5IF4.js} +1297 -91
  11. package/dist/{te-analysis-YGV5V5EX.js → te-analysis-UJDOKPAN.js} +1297 -91
  12. package/dist/te-common-VUX3VOXZ.js +60 -0
  13. package/dist/te-common-XLAGWNIV.js +60 -0
  14. package/dist/te-engage-K4AEUPK5.js +3894 -0
  15. package/dist/te-engage-QBCCME22.js +3894 -0
  16. package/dist/te-experiment-JINSMHMW.js +606 -0
  17. package/dist/te-experiment-NWNQHJS5.js +606 -0
  18. package/dist/{te-kb-NT33UHAE.js → te-kb-AYCODNU6.js} +56 -17
  19. package/dist/{te-meta-VKWNAWO4.js → te-meta-ARDIW3YI.js} +1 -234
  20. package/dist/{te-meta-MAAUHFQO.js → te-meta-UUROEODR.js} +1 -234
  21. package/package.json +2 -1
  22. package/skills/ae-analysis/SKILL.md +10 -7
  23. package/skills/ae-analysis/references/adhoc_export.md +3 -6
  24. package/skills/ae-analysis/references/adhoc_run.md +5 -9
  25. package/skills/ae-analysis/references/ai_models.md +17 -1
  26. package/skills/ae-analysis/references/analysis_data_retrieval.md +11 -11
  27. package/skills/ae-analysis/references/analysis_drilldown_contract.md +93 -0
  28. package/skills/ae-analysis/references/analysis_gateway_assets.md +9 -8
  29. package/skills/ae-analysis/references/asset_url_get.md +4 -3
  30. package/skills/ae-analysis/references/bi_panel_page_data_export.md +2 -2
  31. package/skills/ae-analysis/references/bi_panel_page_data_run.md +1 -1
  32. package/skills/ae-analysis/references/command_index.md +62 -28
  33. package/skills/ae-analysis/references/create_entity.md +2 -2
  34. package/skills/ae-analysis/references/dashboard_report_data_export.md +2 -2
  35. package/skills/ae-analysis/references/dashboard_report_data_run.md +2 -2
  36. package/skills/ae-analysis/references/drilldown_entities_export.md +26 -0
  37. package/skills/ae-analysis/references/drilldown_entities_run.md +33 -0
  38. package/skills/ae-analysis/references/drilldown_events_export.md +21 -0
  39. package/skills/ae-analysis/references/drilldown_events_run.md +23 -0
  40. package/skills/ae-analysis/references/drilldown_user_events_export.md +6 -3
  41. package/skills/ae-analysis/references/drilldown_user_events_run.md +6 -6
  42. package/skills/ae-analysis/references/entity_detail_export.md +2 -0
  43. package/skills/ae-analysis/references/entity_detail_run.md +8 -1
  44. package/skills/ae-analysis/references/event_detail_export.md +2 -0
  45. package/skills/ae-analysis/references/event_detail_run.md +2 -0
  46. package/skills/ae-analysis/references/event_list.md +10 -2
  47. package/skills/ae-analysis/references/list_entities.md +1 -1
  48. package/skills/ae-analysis/references/metric_create.md +13 -4
  49. package/skills/ae-analysis/references/metric_delete.md +7 -0
  50. package/skills/ae-analysis/references/metric_get.md +6 -0
  51. package/skills/ae-analysis/references/metric_list.md +16 -3
  52. package/skills/ae-analysis/references/metric_update.md +12 -1
  53. package/skills/ae-analysis/references/project_access_detail_get.md +23 -0
  54. package/skills/ae-analysis/references/project_data_power_delete.md +26 -0
  55. package/skills/ae-analysis/references/project_data_power_get.md +24 -0
  56. package/skills/ae-analysis/references/project_data_power_list.md +23 -0
  57. package/skills/ae-analysis/references/project_data_power_upsert.md +24 -0
  58. package/skills/ae-analysis/references/project_entity_create.md +27 -0
  59. package/skills/ae-analysis/references/project_entity_delete.md +25 -0
  60. package/skills/ae-analysis/references/project_entity_event_list.md +24 -0
  61. package/skills/ae-analysis/references/project_entity_get.md +24 -0
  62. package/skills/ae-analysis/references/project_entity_list.md +28 -0
  63. package/skills/ae-analysis/references/project_entity_update.md +28 -0
  64. package/skills/ae-analysis/references/project_function_list.md +24 -0
  65. package/skills/ae-analysis/references/project_info_get.md +23 -0
  66. package/skills/ae-analysis/references/project_info_list.md +26 -0
  67. package/skills/ae-analysis/references/project_info_update.md +25 -0
  68. package/skills/ae-analysis/references/project_mark_time_create.md +27 -0
  69. package/skills/ae-analysis/references/project_mark_time_delete.md +25 -0
  70. package/skills/ae-analysis/references/project_mark_time_list.md +28 -0
  71. package/skills/ae-analysis/references/project_mark_time_update.md +28 -0
  72. package/skills/ae-analysis/references/project_member_add.md +25 -0
  73. package/skills/ae-analysis/references/project_member_batch_update.md +24 -0
  74. package/skills/ae-analysis/references/project_member_candidate_list.md +25 -0
  75. package/skills/ae-analysis/references/project_member_handover_export.md +27 -0
  76. package/skills/ae-analysis/references/project_member_handover_run.md +24 -0
  77. package/skills/ae-analysis/references/project_member_import.md +25 -0
  78. package/skills/ae-analysis/references/project_member_list.md +23 -0
  79. package/skills/ae-analysis/references/project_member_receiver_list.md +23 -0
  80. package/skills/ae-analysis/references/project_member_remove.md +26 -0
  81. package/skills/ae-analysis/references/project_member_update.md +25 -0
  82. package/skills/ae-analysis/references/project_owner_update.md +27 -0
  83. package/skills/ae-analysis/references/project_permission_binding_list.md +24 -0
  84. package/skills/ae-analysis/references/project_receive_status_update.md +25 -0
  85. package/skills/ae-analysis/references/project_role_delete.md +25 -0
  86. package/skills/ae-analysis/references/project_role_function_list.md +27 -0
  87. package/skills/ae-analysis/references/project_role_get.md +23 -0
  88. package/skills/ae-analysis/references/project_role_list.md +25 -0
  89. package/skills/ae-analysis/references/project_role_upsert.md +24 -0
  90. package/skills/ae-analysis/references/project_role_user_list.md +23 -0
  91. package/skills/ae-analysis/references/project_timezone_get.md +23 -0
  92. package/skills/ae-analysis/references/project_timezone_overview.md +23 -0
  93. package/skills/ae-analysis/references/project_timezone_update.md +25 -0
  94. package/skills/ae-analysis/references/project_user_id_items_update.md +24 -0
  95. package/skills/ae-analysis/references/property_list.md +21 -6
  96. package/skills/ae-analysis/references/public_link_create.md +1 -1
  97. package/skills/ae-analysis/references/query_create_result_cluster.md +14 -32
  98. package/skills/ae-analysis/references/report_create.md +1 -1
  99. package/skills/ae-analysis/references/report_data_export.md +2 -2
  100. package/skills/ae-analysis/references/report_data_run.md +2 -2
  101. package/skills/ae-analysis/references/report_get.md +2 -0
  102. package/skills/ae-analysis/references/report_update.md +1 -1
  103. package/skills/ae-analysis/references/user_cluster_create.md +3 -1
  104. package/skills/ae-analysis/references/user_cluster_get.md +4 -0
  105. package/skills/ae-analysis/references/user_cluster_refresh.md +4 -2
  106. package/skills/ae-analysis/references/user_cluster_update.md +3 -1
  107. package/skills/ae-analysis/references/user_tag_create.md +3 -1
  108. package/skills/ae-analysis/references/user_tag_get.md +4 -0
  109. package/skills/ae-analysis/references/user_tag_refresh.md +4 -2
  110. package/skills/ae-analysis/references/user_tag_update.md +3 -1
  111. package/skills/ae-analysis/references/virtual_event_create.md +22 -3
  112. package/skills/ae-analysis/references/virtual_property_create.md +23 -2
  113. package/skills/ae-engage/SKILL.md +202 -7
  114. package/skills/ae-engage/references/activity-activity-type.md +42 -0
  115. package/skills/ae-engage/references/activity-activity.md +70 -0
  116. package/skills/ae-engage/references/activity-approval.md +53 -0
  117. package/skills/ae-engage/references/activity-task.md +87 -0
  118. package/skills/ae-engage/references/activity-topic.md +98 -0
  119. package/skills/ae-engage/references/approval-approver-delete.md +26 -0
  120. package/skills/ae-engage/references/channel-test-send.md +37 -0
  121. package/skills/ae-engage/references/channel-touch-limits-batch-update.md +28 -0
  122. package/skills/ae-engage/references/channel-touch-limits-save.md +37 -0
  123. package/skills/ae-engage/references/channel-touch-limits-toggle.md +28 -0
  124. package/skills/ae-engage/references/channel-update-config.md +36 -0
  125. package/skills/ae-engage/references/client-param.md +58 -0
  126. package/skills/ae-engage/references/common-metric.md +75 -0
  127. package/skills/ae-engage/references/config-table.md +92 -0
  128. package/skills/ae-engage/references/engage-scene-config-item.md +69 -0
  129. package/skills/ae-engage/references/operation-log-query.md +1 -1
  130. package/skills/ae-engage/references/preset-event.md +42 -0
  131. package/skills/ae-engage/references/push-language.md +39 -0
  132. package/skills/ae-engage/references/scene-config-channel.md +58 -0
  133. package/skills/ae-engage/references/scene-config-group.md +62 -0
  134. package/skills/ae-engage/references/scene-config-item.md +68 -0
  135. package/skills/ae-engage/references/scene-config-metric.md +79 -0
  136. package/skills/ae-engage/references/scene-config-param.md +72 -0
  137. package/skills/ae-engage/references/scene-preset-metric.md +45 -0
  138. package/skills/ae-engage/references/scene-strategy.md +47 -0
  139. package/skills/ae-engage/references/scene-template.md +71 -0
  140. package/skills/ae-engage/references/{ops-delete.md → task-delete.md} +3 -3
  141. package/skills/ae-engage/references/whitelist.md +72 -0
  142. package/skills/ae-engage/references/workbench-workbench.md +48 -0
  143. package/skills/ae-experiment/SKILL.md +64 -0
  144. package/skills/ae-experiment/references/batch_delete_experiment.md +11 -0
  145. package/skills/ae-experiment/references/batch_delete_feature.md +11 -0
  146. package/skills/ae-experiment/references/batch_delete_traffic_layer.md +11 -0
  147. package/skills/ae-experiment/references/cancel_experiment_query_by_request_id.md +10 -0
  148. package/skills/ae-experiment/references/check_experiment_ready.md +13 -0
  149. package/skills/ae-experiment/references/delete_metric.md +11 -0
  150. package/skills/ae-experiment/references/manage_experiment.md +15 -0
  151. package/skills/ae-experiment/references/manage_feature_status.md +11 -0
  152. package/skills/ae-experiment/references/query_bucket_list.md +10 -0
  153. package/skills/ae-experiment/references/query_experiment_detail.md +11 -0
  154. package/skills/ae-experiment/references/query_experiment_list.md +10 -0
  155. package/skills/ae-experiment/references/query_experiment_metric_trend.md +16 -0
  156. package/skills/ae-experiment/references/query_experiment_report_summary.md +12 -0
  157. package/skills/ae-experiment/references/query_experiment_sample_size_report.md +16 -0
  158. package/skills/ae-experiment/references/query_feature_detail.md +12 -0
  159. package/skills/ae-experiment/references/query_feature_list.md +10 -0
  160. package/skills/ae-experiment/references/query_metric_detail.md +11 -0
  161. package/skills/ae-experiment/references/query_metric_list.md +10 -0
  162. package/skills/ae-experiment/references/query_traffic_layer_detail.md +11 -0
  163. package/skills/ae-experiment/references/query_traffic_layer_list.md +10 -0
  164. package/skills/ae-experiment/references/save_experiment.md +17 -0
  165. package/skills/ae-experiment/references/save_feature.md +13 -0
  166. package/skills/ae-experiment/references/save_metric.md +13 -0
  167. package/skills/ae-experiment/references/save_submit_experiment.md +13 -0
  168. package/skills/ae-experiment/references/save_traffic_layer.md +13 -0
  169. package/skills/ae-generate-tracking-plan/SKILL.md +8 -5
  170. package/skills/ae-generate-tracking-plan/references/te-api.md +1 -1
  171. package/skills/ae-kb/SKILL.md +34 -8
  172. package/skills/ae-metadata/SKILL.md +1 -1
  173. package/skills/ae-metadata/references/metadata_event_get.md +4 -4
  174. package/skills/ae-metadata/references/metadata_property_dimension_table_bind_existing.md +1 -1
  175. package/skills/ae-metadata/references/metadata_property_get.md +4 -4
  176. package/dist/te-common-5NJLF3XG.js +0 -130
  177. package/dist/te-common-7VTJZPII.js +0 -130
  178. package/dist/te-engage-BUWVSSSK.js +0 -1912
  179. package/dist/te-engage-EPE3QKDE.js +0 -1912
  180. package/skills/ae-analysis/references/create_metric.md +0 -58
  181. package/skills/ae-analysis/references/create_virtual_event.md +0 -60
  182. package/skills/ae-analysis/references/create_virtual_property.md +0 -69
  183. package/skills/ae-analysis/references/delete_metric.md +0 -32
  184. package/skills/ae-analysis/references/drilldown_users_export.md +0 -17
  185. package/skills/ae-analysis/references/drilldown_users_run.md +0 -61
  186. package/skills/ae-analysis/references/get_metric.md +0 -38
  187. package/skills/ae-analysis/references/get_resource_url.md +0 -33
  188. package/skills/ae-analysis/references/list_events.md +0 -46
  189. package/skills/ae-analysis/references/list_metrics.md +0 -52
  190. package/skills/ae-analysis/references/list_properties.md +0 -47
  191. package/skills/ae-analysis/references/update_metric.md +0 -58
  192. package/dist/{chunk-HL2AJQ4Q.js → chunk-PTE56QPL.js} +3 -3
@@ -1,8 +1,8 @@
1
1
  # analysis drilldown-user-events run
2
2
 
3
- Query event sequence details for one user after `analysis drilldown-users run`.
3
+ Query event sequence details for one user after a user-subject `analysis drilldown-entities run`.
4
4
 
5
- Use this only after `analysis drilldown-users run` returns a `drilldown_context_id`.
5
+ Use this only when `analysis drilldown-entities run` returns `subject.type=user`, a `drilldown_context_id`, and the user-event follow-up action. Custom entities do not have event sequences.
6
6
 
7
7
  Do not pass raw QP.
8
8
 
@@ -19,15 +19,15 @@ ae-cli analysis drilldown-user-events run \
19
19
 
20
20
  ## Input
21
21
 
22
- - `--drilldown-context-id`: returned by `analysis drilldown-users run`.
23
- - `--user-id`: user id returned by `analysis drilldown-users run`.
24
- - `--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 `["event_time"]`.
22
+ - `--drilldown-context-id`: returned by the same user-subject `analysis drilldown-entities run`.
23
+ - `--user-id`: canonical `user_id` from one item in that same response. Never substitute `entity_value`, `#distinct_id`, account ID, or another identity field.
24
+ - `--properties`: optional exact event-property projection. Omit it to use the default event columns. If present, each item uses backend keys `columnName` and `tableType`, for example `[{"columnName":"<event_property_name>","tableType":"event"}]`. `#user_id`, account ID, visitor ID, event name, and event time remain present; unrelated event properties must not be returned. `#user_id` is an internal association key, so Agents should normally display account ID and visitor ID to customers. Do not pass numeric table-type codes, string-name arrays, or snake_case nested keys.
25
25
  - `--sort-order`: `asc` or `desc`.
26
26
  - `--event-name-filter`, `--time-filter`, `--time-filter-before-nums`, `--time-filter-after-nums`: optional event sequence filters.
27
27
 
28
28
  Do not use raw QP, `query_context_id`, or guessed user IDs for this command.
29
29
 
30
- The `drilldown_context_id` must come from a `drilldown-users` target that includes date context, such as `drilldown_date` or `target_dates`. A context created from `include_total` alone can list users, but may fail event-sequence lookup with `TARGET_DATES_REQUIRED`.
30
+ Do not call this command merely because an entity row looks like a user. The explicit subject and follow-up context are the authority.
31
31
 
32
32
  ## Output
33
33
 
@@ -26,6 +26,8 @@ Do not pass `--limit`; async export rejects inline limits. Use `--artifact-forma
26
26
 
27
27
  Export does not accept `--limit` or `--offset`; backend batching is internal.
28
28
 
29
+ For `entity="user"`, every artifact row includes `#user_id`, `#account_id`, and `#distinct_id` plus requested user properties. For a custom entity, omit `properties`; the artifact contains only the entity value column and rejects additional properties. When presenting user artifacts, Agents should display account ID and visitor ID instead of exposing internal `#user_id` as the only visible identity.
30
+
29
31
  Output:
30
32
 
31
33
  Returns an async descriptor with opaque `run_id` / `artifact_id`, lifecycle status, expiration, and effective timeout/deadline fields. JSONL artifacts start with metadata and schema lines; CSV artifacts start directly with the header and contain only valid CSV records.
@@ -9,7 +9,7 @@ Use this command for the first small entity detail preview that fits inline. It
9
9
  ```bash
10
10
  ae-cli analysis entity-detail run \
11
11
  --project-id <project_id> \
12
- --definition '{"entity":"user","cohort":{"relation":"and","items":[{"field":{"name":"level","type":"user_property"},"operator":"gte","values":[1]}]},"properties":["#user_id",{"name":"country","type":"user_property"}],"sort":[{"field":"#user_id","order":"asc"}]}' \
12
+ --definition '{"entity":"user","cohort":{"relation":"and","items":[{"field":{"name":"level","type":"user_property"},"operator":"gte","values":[1]}]},"properties":[{"name":"country","type":"user_property"}],"sort":[{"field":"#user_id","order":"asc"}]}' \
13
13
  --limit 100
14
14
  ```
15
15
 
@@ -24,6 +24,13 @@ Input:
24
24
 
25
25
  `entity` may be `"user"` for the default user entity or `{ "id": 123 }` in multi-entity projects.
26
26
 
27
+ Property and identity rules depend on the entity:
28
+
29
+ - `entity="user"` resolves to the `#user_id` user entity. `properties` may contain user properties. Every row always contains `#user_id`, `#account_id`, and `#distinct_id` plus the requested properties.
30
+ - A custom entity (`{"id":123}` whose entity column is not `#user_id`) returns only its entity value column. Do not provide `properties`; doing so returns `CUSTOM_ENTITY_PROPERTIES_UNSUPPORTED`.
31
+
32
+ `#user_id` is an internal association key and is normally not meaningful to customers. In user-facing output, Agents should show account ID and visitor ID by default; retain `#user_id` for machine linkage or explicit troubleshooting.
33
+
27
34
  `cohort` is AI-facing for simple entity-set filters and uses the same filter item shape as report/detail filters:
28
35
 
29
36
  ```json
@@ -26,6 +26,8 @@ Do not pass `--limit`; async export rejects inline limits. Use `--artifact-forma
26
26
 
27
27
  Export does not accept `--limit` or `--offset`; backend batching is internal.
28
28
 
29
+ `definition.properties` uses the same exact projection as `event-detail run`. The artifact may include required system event columns, but it must not expand to every visible event property.
30
+
29
31
  Output:
30
32
 
31
33
  Returns an async descriptor with opaque `run_id` / `artifact_id`, lifecycle status, expiration, and effective timeout/deadline fields. JSONL artifacts start with metadata and schema lines; CSV artifacts start directly with the header and contain only valid CSV records.
@@ -51,6 +51,8 @@ Use `{"mode":"relative","relative_date_range":"0-7"}` for recent-day queries.
51
51
 
52
52
  Do not pass raw QP, `eventView`, `taFilters`, `columnName`, or `tableType`.
53
53
 
54
+ When `definition.properties` is present, it is an exact projection: required system event columns remain, requested properties are appended, and unrelated properties must not be returned.
55
+
54
56
  Do not use this command for full, unknown-size, or later-page detail retrieval. Use `analysis event-detail export` and check its artifact metadata for `truncated`.
55
57
 
56
58
  Output:
@@ -1,6 +1,6 @@
1
1
  # analysis-meta event list
2
2
 
3
- Use when the user needs to list project super events.
3
+ Use when the user needs to list project super events, search event metadata, page results, project fields, or filter to authenticated events.
4
4
 
5
5
  Do not use it for raw tracked events, event counts, or one full definition; it lists project super-event metadata.
6
6
 
@@ -8,12 +8,15 @@ Command:
8
8
 
9
9
  ```bash
10
10
  ae-cli analysis-meta event list --project-id <project_id>
11
+ ae-cli analysis-meta event list --project-id <project_id> --query login --fields '["event_name","event_desc","authentication_status"]' --limit 20 --offset 0 --authenticated-only
11
12
  ae-cli analysis-meta event list --dry-run
12
13
  ```
13
14
 
14
15
  Capability id: `metadata.event.list`.
15
16
 
16
- Input sends `project_id`.
17
+ Input sends `project_id`, `query`, `fields`, `limit`, `offset`, and `authenticated_only`.
18
+
19
+ Use snake_case projection fields: `event_id`, `event_name`, `event_desc`, `remark`, `event_tag`, `authentication_status`. Do not send legacy camelCase field names.
17
20
 
18
21
  Output `data.events[]` contains project super-event metadata records.
19
22
 
@@ -21,3 +24,8 @@ Output `data.events[]` contains project super-event metadata records.
21
24
  | Parameter | Required | Description |
22
25
  |---|---|---|
23
26
  | `--project-id` | Yes | Numeric project ID. |
27
+ | `--query` / `-q` | No | Optional keyword filter. Fuzzy match is applied to `event_name`, `event_desc`, and `remark`. |
28
+ | `--fields` / `-f` | No | Optional JSON array of snake_case fields to return. |
29
+ | `--limit` / `-l` | No | Optional page size. When omitted, existing full-list behavior is preserved. Maximum: 50. |
30
+ | `--offset` / `-o` | No | Optional zero-based page offset. |
31
+ | `--authenticated-only` | No | When true, return only authenticated events and include `authentication_status` when projected. |
@@ -39,4 +39,4 @@ ae-cli analysis_meta +list_entities --dry-run
39
39
  - If the result is empty, first confirm the project ID/keyword, then try loosening the filter conditions.
40
40
 
41
41
  ## Recommended Chaining
42
- - +list_entities -> +create_virtual_property / +create_virtual_event
42
+ - +list_entities -> analysis-meta virtual-property create / analysis-meta virtual-event create
@@ -2,13 +2,14 @@
2
2
 
3
3
  Use when the user needs to create a metric from event or retention analysis configuration.
4
4
 
5
- Do not use it to query metric values. Use this gateway command for an exact metric definition; use `analysis_meta +create_metric` only when the gateway capability is unavailable.
5
+ Do not use it to query metric values. Use this gateway command for an exact metric definition.
6
6
 
7
7
  Command:
8
8
 
9
9
  ```bash
10
- ae-cli analysis-meta metric create --project-id <project_id> --metric-name pay_amount --metric-desc 'Pay Amount' --metric-mode <mode> --metric-events '[...]' --metric-params '{}'
11
- ae-cli analysis-meta metric create --project-id <project_id> --metric-name pay_amount --metric-desc 'Pay Amount' --metric-mode <mode> --metric-events '[...]' --dry-run
10
+ ae-cli analysis-meta metric create --project-id <project_id> --metric-name pay_amount --metric-desc 'Pay Amount' --model-type event --metric-events '[...]' --metric-params '{}'
11
+ ae-cli analysis-meta metric create --project-id <project_id> --metric-name retained_users --metric-desc 'Retained Users' --model-type retention --metric-events '[...]' --metric-params '{}'
12
+ ae-cli analysis-meta metric create --project-id <project_id> --metric-name pay_amount --metric-desc 'Pay Amount' --metric-mode 0 --metric-events '[...]' --dry-run
12
13
  ```
13
14
 
14
15
  Capability id: `metadata.metric.create`.
@@ -23,7 +24,15 @@ Output `data.metric` contains the created metric summary.
23
24
  | `--project-id` | Yes | Numeric project ID. |
24
25
  | `--metric-name` | Yes | Metric technical name. |
25
26
  | `--metric-desc` | Yes | Metric display name. |
26
- | `--metric-mode` | Yes | Metric model mode, for example `0` for event analysis. |
27
+ | `--model-type` | No | Semantic metric model type: `event` or `retention`. Prefer this over `--metric-mode`. |
28
+ | `--metric-mode` | No | Metric model mode, for example `0` for event analysis. Required only when `--model-type` is omitted. |
27
29
  | `--metric-events` | Yes | Metric event-analysis QP JSON array. |
28
30
  | `--metric-remark` | No | Metric remark. |
29
31
  | `--metric-params` | No | Metric params JSON object; common defaults it to `{}` when needed. |
32
+
33
+ ## Decision Rules
34
+
35
+ - Pass exactly one semantic model selector when possible: prefer `--model-type event` or `--model-type retention`.
36
+ - `--metric-mode` remains available for existing scripts; if both are provided, they must describe the same model.
37
+ - For event metrics, `--metric-params` is usually a format config such as `{"format":"integer"}`.
38
+ - For retention metrics, `--metric-params` should be the retention `eventView` configuration.
@@ -23,3 +23,10 @@ Output is a successful gateway envelope with no business data. Verify with `metr
23
23
  |---|---|---|
24
24
  | `--project-id` | Yes | Numeric project ID. |
25
25
  | `--metric-id` | Yes | Metric ID. |
26
+
27
+ ## Decision Rules
28
+ - Use `analysis-meta metric list` first to confirm the metric ID before deleting.
29
+ - This is a destructive operation; keep the confirmation prompt unless automation is explicitly required.
30
+
31
+ ## Recommended Chain
32
+ - `analysis-meta metric list` -> `analysis-meta metric delete`
@@ -3,6 +3,7 @@
3
3
  Use when the user needs to get metric definition, events, and params.
4
4
 
5
5
  Do not use it to query metric values or trends; it returns the saved metric definition only.
6
+ Do not call it 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.
6
7
 
7
8
  Command:
8
9
 
@@ -22,3 +23,8 @@ Output `data.metric` contains the saved metric definition, or no metric when the
22
23
  |---|---|---|
23
24
  | `--project-id` | Yes | Numeric project ID. |
24
25
  | `--metric-id` | Yes | Metric ID. |
26
+
27
+ ## Recommended Chaining
28
+
29
+ - analysis-meta metric get -> analysis-meta metric update
30
+ - For ad-hoc saved metric query: analysis adhoc run/export
@@ -1,24 +1,37 @@
1
1
  # analysis-meta metric list
2
2
 
3
- Use when the user needs to list project metrics.
3
+ Use when the user needs to list, search, page, or field-project project metrics.
4
4
 
5
5
  Do not use it to calculate metric values; use report/dashboard/ad-hoc data routing for result queries.
6
6
 
7
7
  Command:
8
8
 
9
9
  ```bash
10
+ ae-cli analysis-meta metric list --project-id <project_id>
10
11
  ae-cli analysis-meta metric list --project-id <project_id> --ignore-authentication true
12
+ ae-cli analysis-meta metric list --project-id <project_id> --query pay
13
+ ae-cli analysis-meta metric list --project-id <project_id> --query pay --fields '["metric_name","authentication_status"]' --limit 10 --offset 0 --authenticated-only true
11
14
  ae-cli analysis-meta metric list --dry-run
12
15
  ```
13
16
 
14
17
  Capability id: `metadata.metric.list`.
15
18
 
16
- Input sends `project_id`, `ignore_authentication`.
19
+ Input sends `project_id`, `ignore_authentication`, `query`, `fields`, `limit`, `offset`, and `authenticated_only`.
17
20
 
18
- Output `data.metrics[]` contains project metric summaries and authentication decoration unless explicitly skipped.
21
+ Output `data.metrics[]` contains project metric summaries. When `limit` or `offset` is present, output also includes `total`, `limit`, `offset`, and `has_more`.
19
22
 
20
23
  ## Parameters
21
24
  | Parameter | Required | Description |
22
25
  |---|---|---|
23
26
  | `--project-id` | Yes | Numeric project ID. |
24
27
  | `--ignore-authentication` | No | Whether to skip asset authentication status decoration. |
28
+ | `--query` | No | Optional keyword filter. Fuzzy match on `metric_name`, `metric_desc`, and `metric_remark`. |
29
+ | `--fields` | No | Optional result field projection JSON array. Supported fields: `metric_id`, `metric_name`, `metric_desc`, `metric_remark`, `metric_mode`, `authentication_status`, `open_id`, `creator`, `creator_login_name`, `update_open_id`, `update_creator`, `update_login_name`, `create_time`, `update_time`. |
30
+ | `--limit` | No | Optional page size. Default: 20 when pagination is used, maximum: 50. |
31
+ | `--offset` | No | Optional zero-based result offset. Default: 0. |
32
+ | `--authenticated-only` | No | When true, return only authenticated metrics. |
33
+
34
+ ## Decision Rules
35
+ - Do not call this just to prepare normal ad-hoc analysis. Pass saved metric wording directly in `analysis adhoc run/export --definition`; the backend compiler resolves saved metric names internally.
36
+ - Use `--fields` to keep discovery responses compact.
37
+ - Use `analysis-meta metric get` after this command when a full metric definition is needed.
@@ -2,12 +2,16 @@
2
2
 
3
3
  Use when the user needs to update metric definition, name, and remark.
4
4
 
5
- Do not use it to query metric values. Use `analysis_meta +update_metric` only when the gateway capability is unavailable.
5
+ Do not use it to query metric values.
6
+
7
+ Before updating `--metric-events` / `--metric-params`, validate the event and property names with `analysis-meta event list` and `analysis-meta property list` in the same `project_id`.
6
8
 
7
9
  Command:
8
10
 
9
11
  ```bash
10
12
  ae-cli analysis-meta metric update --project-id <project_id> --metric-id <metric_id> --metric-desc 'New display name' --metric-remark 'New remark'
13
+ ae-cli analysis-meta metric update --project-id <project_id> --metric-id <metric_id> --metric-name demo --metric-desc demo --model-type event --metric-events '[]'
14
+ ae-cli analysis-meta metric update --project-id <project_id> --metric-id <metric_id> --metric-name demo --metric-desc demo --metric-remark demo --model-type retention --metric-events '[]' --metric-params '{}'
11
15
  ae-cli analysis-meta metric update --project-id <project_id> --metric-id <metric_id> --metric-desc 'New display name' --dry-run
12
16
  ```
13
17
 
@@ -26,5 +30,12 @@ Output `data.metric` contains the updated summary for a full-definition update c
26
30
  | `--metric-desc` | No | Metric display name. |
27
31
  | `--metric-remark` | No | Metric remark. |
28
32
  | `--metric-mode` | No | Metric model mode for a full-definition update. |
33
+ | `--model-type` | No | Semantic metric model type: `event` or `retention`. Prefer this over `--metric-mode`. |
29
34
  | `--metric-events` | No | Metric event-analysis QP JSON array for a full-definition update. |
30
35
  | `--metric-params` | No | Metric params JSON object. |
36
+
37
+ ## Decision Rules
38
+ - For full-definition updates, pass `--metric-name`, `--metric-desc`, one of `--model-type` / `--metric-mode`, and `--metric-events` together.
39
+ - If both `--model-type` and `--metric-mode` are present, they must match: `event -> 0`, `retention -> 1`.
40
+ - Use `analysis-meta metric get` before updating if the current definition needs to be preserved and edited.
41
+ - This is an ordinary write operation; execute it without the high-risk confirmation flag.
@@ -0,0 +1,23 @@
1
+ # analysis project access-detail get
2
+
3
+ Use when the user needs to get company project access details.
4
+
5
+ Do not use it for unrelated project-management actions or for fields not present in the common-service capability schema. Do not send camelCase aliases.
6
+
7
+ Command:
8
+
9
+ ```bash
10
+ ae-cli analysis project access-detail get --company-id <company_id>
11
+ ae-cli analysis project access-detail get --dry-run --company-id <company_id>
12
+ ```
13
+
14
+ Capability id: `project.access_detail.get`.
15
+
16
+ Input sends `company_id`. Payload keys, JSON arrays, and projection fields must follow the common-service snake_case input schema.
17
+
18
+ Output uses the gateway envelope: success is `ok=true,data,meta`; failure is `ok=false,error`. Preserve `request_id` and `invocation_id` when present.
19
+
20
+ ## Parameters
21
+ | Parameter | Required | Description |
22
+ |---|---|---|
23
+ | `--company-id` | Yes | Company ID. |
@@ -0,0 +1,26 @@
1
+ # analysis project data-power delete
2
+
3
+ Use when the user needs to delete a data power and optionally migrate users to another data power.
4
+
5
+ Do not use it for unrelated project-management actions or for fields not present in the common-service capability schema. Do not send camelCase aliases.
6
+
7
+ Command:
8
+
9
+ ```bash
10
+ ae-cli analysis project data-power delete --project-id <project_id> --data-power-id <data_power_id> --new-data-power-id <new_data_power_id>
11
+ ae-cli analysis project data-power delete --dry-run --project-id <project_id> --data-power-id <data_power_id>
12
+ ```
13
+
14
+ Capability id: `project.data_power.delete`.
15
+
16
+ Input sends `project_id`, `data_power_id`, `new_data_power_id`, `yes`. Payload keys, JSON arrays, and projection fields must follow the common-service snake_case input schema.
17
+ For execution, dry-run first, summarize the impact, then rerun the unchanged command with global `--yes` only after explicit user confirmation. The CLI sends `yes=true` after its own high-risk gate.
18
+
19
+ Output uses the gateway envelope: success is `ok=true,data,meta`; failure is `ok=false,error`. Preserve `request_id` and `invocation_id` when present.
20
+
21
+ ## Parameters
22
+ | Parameter | Required | Description |
23
+ |---|---|---|
24
+ | `--project-id` | Yes | Numeric project ID. |
25
+ | `--data-power-id` | Yes | Data power ID to delete. |
26
+ | `--new-data-power-id` | No | Optional replacement data power ID for affected users. |
@@ -0,0 +1,24 @@
1
+ # analysis project data-power get
2
+
3
+ Use when the user needs to get one data power detail.
4
+
5
+ Do not use it for unrelated project-management actions or for fields not present in the common-service capability schema. Do not send camelCase aliases.
6
+
7
+ Command:
8
+
9
+ ```bash
10
+ ae-cli analysis project data-power get --project-id <project_id> --data-power-id <data_power_id>
11
+ ae-cli analysis project data-power get --dry-run --project-id <project_id> --data-power-id <data_power_id>
12
+ ```
13
+
14
+ Capability id: `project.data_power.get`.
15
+
16
+ Input sends `project_id`, `data_power_id`. Payload keys, JSON arrays, and projection fields must follow the common-service snake_case input schema.
17
+
18
+ Output uses the gateway envelope: success is `ok=true,data,meta`; failure is `ok=false,error`. Preserve `request_id` and `invocation_id` when present.
19
+
20
+ ## Parameters
21
+ | Parameter | Required | Description |
22
+ |---|---|---|
23
+ | `--project-id` | Yes | Numeric project ID. |
24
+ | `--data-power-id` | Yes | Data power ID. |
@@ -0,0 +1,23 @@
1
+ # analysis project data-power list
2
+
3
+ Use when the user needs to list project data powers.
4
+
5
+ Do not use it for unrelated project-management actions or for fields not present in the common-service capability schema. Do not send camelCase aliases.
6
+
7
+ Command:
8
+
9
+ ```bash
10
+ ae-cli analysis project data-power list --project-id <project_id>
11
+ ae-cli analysis project data-power list --dry-run --project-id <project_id>
12
+ ```
13
+
14
+ Capability id: `project.data_power.list`.
15
+
16
+ Input sends `project_id`. Payload keys, JSON arrays, and projection fields must follow the common-service snake_case input schema.
17
+
18
+ Output uses the gateway envelope: success is `ok=true,data,meta`; failure is `ok=false,error`. Preserve `request_id` and `invocation_id` when present.
19
+
20
+ ## Parameters
21
+ | Parameter | Required | Description |
22
+ |---|---|---|
23
+ | `--project-id` | Yes | Numeric project ID. |
@@ -0,0 +1,24 @@
1
+ # analysis project data-power upsert
2
+
3
+ Use when the user needs to create or update a data power.
4
+
5
+ Do not use it for unrelated project-management actions or for fields not present in the common-service capability schema. Do not send camelCase aliases.
6
+
7
+ Command:
8
+
9
+ ```bash
10
+ ae-cli analysis project data-power upsert --project-id <project_id> --payload <payload>
11
+ ae-cli analysis project data-power upsert --dry-run --project-id <project_id> --payload <payload>
12
+ ```
13
+
14
+ Capability id: `project.data_power.upsert`.
15
+
16
+ Input sends `project_id`, `payload`. Payload keys, JSON arrays, and projection fields must follow the common-service snake_case input schema.
17
+
18
+ Output uses the gateway envelope: success is `ok=true,data,meta`; failure is `ok=false,error`. Preserve `request_id` and `invocation_id` when present.
19
+
20
+ ## Parameters
21
+ | Parameter | Required | Description |
22
+ |---|---|---|
23
+ | `--project-id` | Yes | Numeric project ID. |
24
+ | `--payload` | Yes | Data power save payload matching DataPowerSaveRequestDTO in snake_case. |
@@ -0,0 +1,27 @@
1
+ # analysis project entity create
2
+
3
+ Use when the user needs to create an analysis entity.
4
+
5
+ Do not use it for unrelated project-management actions or for fields not present in the common-service capability schema. Do not send camelCase aliases.
6
+
7
+ Command:
8
+
9
+ ```bash
10
+ ae-cli analysis project entity create --project-id <project_id> --entity-name <entity_name> --column-name <column_name> --table-type <table_type> --order <order>
11
+ ae-cli analysis project entity create --dry-run --project-id <project_id> --entity-name <entity_name> --column-name <column_name> --table-type <table_type>
12
+ ```
13
+
14
+ Capability id: `project.entity.create`.
15
+
16
+ Input sends `project_id`, `entity_name`, `column_name`, `table_type`, `order`. Payload keys, JSON arrays, and projection fields must follow the common-service snake_case input schema.
17
+
18
+ Output uses the gateway envelope: success is `ok=true,data,meta`; failure is `ok=false,error`. Preserve `request_id` and `invocation_id` when present.
19
+
20
+ ## Parameters
21
+ | Parameter | Required | Description |
22
+ |---|---|---|
23
+ | `--project-id` | Yes | Numeric project ID. |
24
+ | `--entity-name` | Yes | Entity display name. |
25
+ | `--column-name` | Yes | Property column name to bind. |
26
+ | `--table-type` | Yes | Main table type: 0 for event property, 1 for user property. |
27
+ | `--order` | No | Optional entity display order. |
@@ -0,0 +1,25 @@
1
+ # analysis project entity delete
2
+
3
+ Use when the user needs to delete an analysis entity.
4
+
5
+ Do not use it for unrelated project-management actions or for fields not present in the common-service capability schema. Do not send camelCase aliases.
6
+
7
+ Command:
8
+
9
+ ```bash
10
+ ae-cli analysis project entity delete --project-id <project_id> --entity-id <entity_id>
11
+ ae-cli analysis project entity delete --dry-run --project-id <project_id> --entity-id <entity_id>
12
+ ```
13
+
14
+ Capability id: `project.entity.delete`.
15
+
16
+ Input sends `project_id`, `entity_id`, `yes`. Payload keys, JSON arrays, and projection fields must follow the common-service snake_case input schema.
17
+ For execution, dry-run first, summarize the impact, then rerun the unchanged command with global `--yes` only after explicit user confirmation. The CLI sends `yes=true` after its own high-risk gate.
18
+
19
+ Output uses the gateway envelope: success is `ok=true,data,meta`; failure is `ok=false,error`. Preserve `request_id` and `invocation_id` when present.
20
+
21
+ ## Parameters
22
+ | Parameter | Required | Description |
23
+ |---|---|---|
24
+ | `--project-id` | Yes | Numeric project ID. |
25
+ | `--entity-id` | Yes | Analysis entity ID. |
@@ -0,0 +1,24 @@
1
+ # analysis project entity-event list
2
+
3
+ Use when the user needs to list entity mappings for events.
4
+
5
+ Do not use it for unrelated project-management actions or for fields not present in the common-service capability schema. Do not send camelCase aliases.
6
+
7
+ Command:
8
+
9
+ ```bash
10
+ ae-cli analysis project entity-event list --project-id <project_id> --event-names <event_names>
11
+ ae-cli analysis project entity-event list --dry-run --project-id <project_id>
12
+ ```
13
+
14
+ Capability id: `project.entity_event.list`.
15
+
16
+ Input sends `project_id`, `event_names`. Payload keys, JSON arrays, and projection fields must follow the common-service snake_case input schema.
17
+
18
+ Output uses the gateway envelope: success is `ok=true,data,meta`; failure is `ok=false,error`. Preserve `request_id` and `invocation_id` when present.
19
+
20
+ ## Parameters
21
+ | Parameter | Required | Description |
22
+ |---|---|---|
23
+ | `--project-id` | Yes | Numeric project ID. |
24
+ | `--event-names` | No | Optional event names JSON array to resolve entity mappings for. |
@@ -0,0 +1,24 @@
1
+ # analysis project entity get
2
+
3
+ Use when the user needs to get one analysis entity.
4
+
5
+ Do not use it for unrelated project-management actions or for fields not present in the common-service capability schema. Do not send camelCase aliases.
6
+
7
+ Command:
8
+
9
+ ```bash
10
+ ae-cli analysis project entity get --project-id <project_id> --entity-id <entity_id>
11
+ ae-cli analysis project entity get --dry-run --project-id <project_id> --entity-id <entity_id>
12
+ ```
13
+
14
+ Capability id: `project.entity.get`.
15
+
16
+ Input sends `project_id`, `entity_id`. Payload keys, JSON arrays, and projection fields must follow the common-service snake_case input schema.
17
+
18
+ Output uses the gateway envelope: success is `ok=true,data,meta`; failure is `ok=false,error`. Preserve `request_id` and `invocation_id` when present.
19
+
20
+ ## Parameters
21
+ | Parameter | Required | Description |
22
+ |---|---|---|
23
+ | `--project-id` | Yes | Numeric project ID. |
24
+ | `--entity-id` | Yes | Analysis entity ID. |
@@ -0,0 +1,28 @@
1
+ # analysis project entity list
2
+
3
+ Use when the user needs to list analysis entities in a project.
4
+
5
+ Do not use it for unrelated project-management actions or for fields not present in the common-service capability schema. Do not send camelCase aliases.
6
+
7
+ Command:
8
+
9
+ ```bash
10
+ ae-cli analysis project entity list --project-id <project_id> --query <query> --fields <fields> --limit <limit> --offset <offset> --event-name <event_name>
11
+ ae-cli analysis project entity list --dry-run --project-id <project_id>
12
+ ```
13
+
14
+ Capability id: `project.entity.list`.
15
+
16
+ Input sends `project_id`, `query`, `fields`, `limit`, `offset`, `event_name`. Payload keys, JSON arrays, and projection fields must follow the common-service snake_case input schema.
17
+
18
+ Output uses the gateway envelope: success is `ok=true,data,meta`; failure is `ok=false,error`. Preserve `request_id` and `invocation_id` when present.
19
+
20
+ ## Parameters
21
+ | Parameter | Required | Description |
22
+ |---|---|---|
23
+ | `--project-id` | Yes | Numeric project ID. |
24
+ | `--query` | No | Optional keyword filter. |
25
+ | `--fields` | No | Optional snake_case fields to return. |
26
+ | `--limit` | No | Optional page size. Default: 50, maximum: 200. |
27
+ | `--offset` | No | Optional page offset. Default: 0. |
28
+ | `--event-name` | No | Optional event name. When present, return entities related to the event. |
@@ -0,0 +1,28 @@
1
+ # analysis project entity update
2
+
3
+ Use when the user needs to update an analysis entity.
4
+
5
+ Do not use it for unrelated project-management actions or for fields not present in the common-service capability schema. Do not send camelCase aliases.
6
+
7
+ Command:
8
+
9
+ ```bash
10
+ ae-cli analysis project entity update --project-id <project_id> --entity-id <entity_id> --entity-name <entity_name> --column-name <column_name> --table-type <table_type> --order <order>
11
+ ae-cli analysis project entity update --dry-run --project-id <project_id> --entity-id <entity_id> --entity-name <entity_name> --column-name <column_name> --table-type <table_type>
12
+ ```
13
+
14
+ Capability id: `project.entity.update`.
15
+
16
+ Input sends `project_id`, `entity_id`, `entity_name`, `column_name`, `table_type`, `order`. Payload keys, JSON arrays, and projection fields must follow the common-service snake_case input schema.
17
+
18
+ Output uses the gateway envelope: success is `ok=true,data,meta`; failure is `ok=false,error`. Preserve `request_id` and `invocation_id` when present.
19
+
20
+ ## Parameters
21
+ | Parameter | Required | Description |
22
+ |---|---|---|
23
+ | `--project-id` | Yes | Numeric project ID. |
24
+ | `--entity-id` | Yes | Analysis entity ID. |
25
+ | `--entity-name` | Yes | Entity display name. |
26
+ | `--column-name` | Yes | Property column name to bind. |
27
+ | `--table-type` | Yes | Main table type: 0 for event property, 1 for user property. |
28
+ | `--order` | No | Optional entity display order. |
@@ -0,0 +1,24 @@
1
+ # analysis project function list
2
+
3
+ Use when the user needs to list all project-level functions.
4
+
5
+ Do not use it for unrelated project-management actions or for fields not present in the common-service capability schema. Do not send camelCase aliases.
6
+
7
+ Command:
8
+
9
+ ```bash
10
+ ae-cli analysis project function list --company-id <company_id> --project-id <project_id>
11
+ ae-cli analysis project function list --dry-run
12
+ ```
13
+
14
+ Capability id: `project.function.list`.
15
+
16
+ Input sends `company_id`, `project_id`. Payload keys, JSON arrays, and projection fields must follow the common-service snake_case input schema.
17
+
18
+ Output uses the gateway envelope: success is `ok=true,data,meta`; failure is `ok=false,error`. Preserve `request_id` and `invocation_id` when present.
19
+
20
+ ## Parameters
21
+ | Parameter | Required | Description |
22
+ |---|---|---|
23
+ | `--company-id` | No | Company ID. |
24
+ | `--project-id` | No | Project ID. |
@@ -0,0 +1,23 @@
1
+ # analysis project info get
2
+
3
+ Use when the user needs to get project configuration details.
4
+
5
+ Do not use it for unrelated project-management actions or for fields not present in the common-service capability schema. Do not send camelCase aliases.
6
+
7
+ Command:
8
+
9
+ ```bash
10
+ ae-cli analysis project info get --project-id <project_id>
11
+ ae-cli analysis project info get --dry-run --project-id <project_id>
12
+ ```
13
+
14
+ Capability id: `project.info.get`.
15
+
16
+ Input sends `project_id`. Payload keys, JSON arrays, and projection fields must follow the common-service snake_case input schema.
17
+
18
+ Output uses the gateway envelope: success is `ok=true,data,meta`; failure is `ok=false,error`. Preserve `request_id` and `invocation_id` when present.
19
+
20
+ ## Parameters
21
+ | Parameter | Required | Description |
22
+ |---|---|---|
23
+ | `--project-id` | Yes | Numeric project ID. |
@@ -0,0 +1,26 @@
1
+ # analysis project info list
2
+
3
+ Use when the user needs to list projects accessible to the current user.
4
+
5
+ Do not use it for unrelated project-management actions or for fields not present in the common-service capability schema. Do not send camelCase aliases.
6
+
7
+ Command:
8
+
9
+ ```bash
10
+ ae-cli analysis project info list --query <query> --fields <fields> --limit <limit> --offset <offset>
11
+ ae-cli analysis project info list --dry-run
12
+ ```
13
+
14
+ Capability id: `project.info.list`.
15
+
16
+ Input sends `query`, `fields`, `limit`, `offset`. Payload keys, JSON arrays, and projection fields must follow the common-service snake_case input schema.
17
+
18
+ Output uses the gateway envelope: success is `ok=true,data,meta`; failure is `ok=false,error`. Preserve `request_id` and `invocation_id` when present.
19
+
20
+ ## Parameters
21
+ | Parameter | Required | Description |
22
+ |---|---|---|
23
+ | `--query` | No | Optional keyword filter. |
24
+ | `--fields` | No | Optional snake_case fields to return. |
25
+ | `--limit` | No | Optional page size. Default: 50, maximum: 200. |
26
+ | `--offset` | No | Optional page offset. Default: 0. |