Skip to main content

Data Analysis

This category lists the 23 Runtime system commands under system.analysis..

1. List datasets​

Full name: system.analysis.dataset.list

List analysis dataset records. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: Read

sl system analysis dataset list \
[--keyword value] [--cursor value] [--limit n] [--json]

Parameters:

  • keyword(optional)— Dataset name/description filter
  • cursor(optional)— Opaque nextCursor returned by the previous request
  • limit(optional)— Maximum items from 1 to 100

2. Retrieve dataset​

Full name: system.analysis.dataset.get

Retrieve analysis dataset resource. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: Read

sl system analysis dataset get --dataset-id <uuid> [--json]

Parameters:

  • datasetId(required)— Discovered persistent dataset UUID

3. Query dataset​

Full name: system.analysis.dataset.query

Query the analysis dataset Runtime operation. This tenant-scoped command validates its input against the registered command schema. · Risk: Read

sl system analysis dataset query \
--dataset-id <uuid> (--query-json json|--query-file path) [--json]

Parameters:

  • datasetId(required)— Discovered persistent dataset UUID
  • chartId(optional)— Optional discovered chart UUID for chart-aware execution
  • mode(optional)— aggregate (default) or detail
  • detailFields(optional)— Required non-empty dataset field keys when mode=detail
  • dimensions(optional)— Up to 12 discovered DIMENSION field keys
  • measures(optional)— Up to 12 discovered MEASURE field keys
  • metricSpecs(optional)— Explicit aggregate metrics; non-count functions require fieldKey
  • limit(optional)— Returned rows/categories from 1 to 100
  • timeGrain(optional)— day, week, month, quarter, or year
  • condition(optional)— A field/operator rule or recursive and/or group using dataset field keys
  • baseRecordTimeField(optional)— updatedAt or createdAt
  • pagination(optional)— Detail-query cursor page: opaque cursor, forward/backward direction, and one-to-five-page jump
  • bindingScript(optional)— Published Studio script binding for numeric computed measures

4. Create dataset​

Full name: system.analysis.dataset.create

Create analysis dataset resource. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: Write

sl system analysis dataset create \
(--definition-json json|--definition-file path) [--json]

Parameters:

  • name(required)— Dataset name
  • description(optional)— Nullable description. Optional only on create
  • sourceConfig(required)— Complete base form, joins, and computed-field configuration
  • fields(required)— Complete persisted field snapshot

5. Update dataset​

Full name: system.analysis.dataset.update

Update analysis dataset resource. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: Write

sl system analysis dataset update \
--dataset-id <uuid> (--definition-json json|--definition-file path) \
[--json]

Parameters:

  • datasetId(required)— Existing editable dataset UUID
  • name(required)— Dataset name
  • description(required)— Nullable description. Optional only on create
  • sourceConfig(required)— Complete base form, joins, and computed-field configuration
  • fields(required)— Complete persisted field snapshot

6. Delete dataset​

Full name: system.analysis.dataset.delete

Delete analysis dataset resource. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: High risk

sl system analysis dataset delete \
--dataset-id <uuid> [--delete-charts] [--json]

Parameters:

  • datasetId(required)— Existing deletable dataset UUID
  • deleteCharts(optional)— Also delete dependent charts; otherwise dependencies reject deletion

7. Create session dataset​

Full name: system.analysis.session-dataset.create

Create a conversation-scoped dataset from discovered business form fields for analysis and chart delivery in chat. Does not save an item in the visualization directory. · Risk: Session write

sl system analysis session-dataset create \
--thread-id <uuid> [--app-code value] \
(--definition-json json|--definition-file path) [--json]

Parameters:

  • name(required)— Conversation-scoped dataset name
  • sourceConfig(required)— Complete base form and left-join graph
  • fields(required)— One to 80 physical or expression-computed fields

8. List session datasets​

Full name: system.analysis.session-dataset.list

List analysis session dataset records. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: Read

sl system analysis session-dataset list \
--thread-id <uuid> [--app-code value] [--json]

Parameters: none beyond common options such as --json.

9. Retrieve session dataset​

Full name: system.analysis.session-dataset.get

Retrieve analysis session dataset resource. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: Read

sl system analysis session-dataset get \
--thread-id <uuid> --session-dataset-id <uuid> [--app-code value] \
[--json]

Parameters:

  • sessionDatasetId(required)— Session dataset UUID from this conversation

10. Query session dataset​

Full name: system.analysis.session-dataset.query

Query the analysis session dataset Runtime operation. This tenant-scoped command validates its input against the registered command schema. · Risk: Read

sl system analysis session-dataset query \
--thread-id <uuid> --session-dataset-id <uuid> [--app-code value] \
(--query-json json|--query-file path) [--json]

Parameters:

  • sessionDatasetId(required)— Session dataset UUID from this conversation
  • mode(optional)— aggregate (default) or detail
  • detailFields(optional)— Required non-empty dataset field keys when mode=detail
  • dimensions(optional)— Up to 12 discovered DIMENSION field keys
  • measures(optional)— Up to 12 discovered MEASURE field keys
  • metricSpecs(optional)— Explicit aggregate metrics; non-count functions require fieldKey
  • limit(optional)— Returned rows/categories from 1 to 100
  • timeGrain(optional)— day, week, month, quarter, or year
  • condition(optional)— A field/operator rule or recursive and/or group using dataset field keys
  • baseRecordTimeField(optional)— updatedAt or createdAt

11. Delete session dataset​

Full name: system.analysis.session-dataset.delete-for-thread

Delete analysis session dataset resource. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: Session write

sl system analysis session-dataset delete-for-thread \
--thread-id <uuid> [--app-code value] [--json]

Parameters: none beyond common options such as --json.

12. Create session report​

Full name: system.analysis.session-report.create

Render and deliver an interactive system chart card in the current conversation using a session dataset. This completes the default chat visualization delivery. · Risk: Session write

sl system analysis session-report create \
--thread-id <uuid> [--app-code value] \
(--definition-json json|--definition-file path) [--json]

Parameters: none beyond common options such as --json.

13. Publish session report​

Full name: system.analysis.session-report.publish

Publish analysis session report resource. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: Write

sl system analysis session-report publish \
--thread-id <uuid> --message-id value --report-id <uuid> --name value \
[--parent-id <uuid>] [--app-code value] [--json]

Parameters: none beyond common options such as --json.

14. Retrieve session report publication​

Full name: system.analysis.session-report.publication.get

Retrieve analysis session report publication resource. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: Read

sl system analysis session-report publication get \
--thread-id <uuid> --message-id value --report-id <uuid> \
[--app-code value] [--json]

Parameters: none beyond common options such as --json.

15. List charts​

Full name: system.analysis.chart.list

List analysis chart records. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: Read

sl system analysis chart list \
[--chart-type value] [--keyword value] [--cursor value] [--limit n] \
[--json]

Parameters:

  • chartType(optional)— Exact chart type filter from chartConfiguration.enums.chartType
  • keyword(optional)— Case-insensitive chart-name/description filter
  • cursor(optional)— Opaque nextCursor returned by the previous request
  • limit(optional)— Maximum items from 1 to 100; defaults to 20

16. Retrieve chart​

Full name: system.analysis.chart.get

Retrieve analysis chart resource. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: Read

sl system analysis chart get --chart-id <uuid> [--json]

Parameters:

  • chartId(required)— Existing chart/dashboard UUID returned by chart list

17. Create chart​

Full name: system.analysis.chart.create

Save a persistent chart in the visualization directory only when requested. This command does not deliver a chart card in chat. · Risk: Write

sl system analysis chart create \
(--definition-json json|--definition-file path) [--json]

Parameters:

  • datasetId(required)— Existing dataset UUID for charts; null for dashboards
  • parentId(required)— Existing folder UUID or null for root
  • name(required)— Displayed chart/dashboard name
  • description(required)— Nullable management and tooltip description
  • chartType(required)— Chart/dashboard renderer from chartConfiguration.enums.chartType
  • dataConfig(required)— Complete data, permission, filter, or dashboard config described by chartConfiguration
  • visualConfig(required)— Either {} or the complete visual config described by chartConfiguration
  • thumbnailUrl(required)— Nullable preview image URL/data URL

18. Update chart​

Full name: system.analysis.chart.update

Update analysis chart resource. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: Write

sl system analysis chart update \
--chart-id <uuid> (--definition-json json|--definition-file path) \
[--json]

Parameters:

  • chartId(required)— Existing editable chart/dashboard UUID
  • datasetId(required)— Existing dataset UUID for charts; null for dashboards
  • parentId(required)— Existing folder UUID or null for root
  • name(required)— Displayed chart/dashboard name
  • description(required)— Nullable management and tooltip description
  • chartType(required)— Chart/dashboard renderer from chartConfiguration.enums.chartType
  • dataConfig(required)— Complete data, permission, filter, or dashboard config described by chartConfiguration
  • visualConfig(required)— Either {} or the complete visual config described by chartConfiguration
  • thumbnailUrl(required)— Nullable preview image URL/data URL

19. Delete chart​

Full name: system.analysis.chart.delete

Delete analysis chart resource. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: High risk

sl system analysis chart delete --chart-id <uuid> [--json]

Parameters:

  • chartId(required)— Existing deletable chart/dashboard UUID

20. List folders​

Full name: system.analysis.folder.list

List analysis folder records. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: Read

sl system analysis folder list \
[--keyword value] [--cursor value] [--limit n] [--json]

Parameters:

  • keyword(optional)— Case-insensitive folder-name filter
  • cursor(optional)— Opaque nextCursor returned by the previous request
  • limit(optional)— Maximum items from 1 to 100; defaults to 20

21. Create folder​

Full name: system.analysis.folder.create

Create analysis folder resource. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: Write

sl system analysis folder create \
--name value [--parent-id <uuid>] [--json]

Parameters:

  • name(required)— Folder name, trimmed and limited to 100 characters
  • parentId(optional)— Existing parent-folder UUID; omit or use null to create at root

22. Delete folder​

Full name: system.analysis.folder.delete

Delete analysis folder resource. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: High risk

sl system analysis folder delete \
--folder-id <uuid> \
(--delete-charts|--target-parent-id <uuid>|--move-to-root) [--json]

Parameters:

  • folderId(required)— Folder-tree root UUID to delete
  • deleteCharts(required)— true deletes charts in this folder tree; false moves them before deleting the tree
  • targetParentId(optional)— Required when deleteCharts=false. Use an existing folder UUID to move charts there, or null to move them to root

23. Query a saved report or chart​

Full name: system.analysis.chart.query

Read current tenant data using the saved report configuration, including selected fields, filters, aggregation, time grain and binding script. The command requires chart view and source data access. It supports reports and individual charts; dashboards are excluded. · Risk: Read

sl system analysis chart query --chart-id <uuid> [--json]
  • chartId (required): UUID from /visualization/view/<uuid> or system.analysis.chart.list.
  • Results contain queryResult and limits. When limits.truncated is true, analysis must disclose the row/category limit.
  • Automation: Visualization → Agent Execution (analysis instructions) → Message (group chat). Enable this command for both automation agents and group-chat agents that analyze reports. In group chat, linked reports are queried only when the command is enabled, under the requesting member’s chart and source-data permissions. Analysis is sent as ordinary group text.