akili superset

Manage Apache Superset dashboard integration for data products. The Superset integration enables self-service analytics by automatically provisioning dashboards from data products that use the analytics serving intent.

Commands

akili superset provision <product>

Provision a new Superset dashboard for a data product. The platform creates a dataset in Superset backed by the product’s analytics serving store (StarRocks) and generates a starter dashboard.

Arguments:

Argument	Type	Required	Description
product	string	yes	Product name or ID

Examples:

# Provision a dashboard
akili superset provision daily-orders

# Output:
# Dashboard provisioned for 'daily-orders': status=provisioned
# URL: https://superset.akili.io/superset/dashboard/42/

Note

The product must have a serving intent of analytics with a StarRocks-backed materialization. Products without an analytics serving configuration will fail provisioning.

---

akili superset status <product>

Show the current Superset dashboard status for a product, including the dashboard URL and provisioning state.

Arguments:

Argument	Type	Required	Description
product	string	yes	Product name or ID

Examples:

# Check dashboard status
akili superset status daily-orders

# Show as JSON for CI/CD
akili superset status daily-orders --json

---

akili superset guest-token <product>

Generate a time-limited guest token for embedding a Superset dashboard in an external application. The token grants read-only access to the specific product’s dashboard and expires after a configurable duration.

Arguments:

Argument	Type	Required	Description
product	string	yes	Product name or ID

Flags:

Flag	Short	Default	Description
--user-id			User ID for the guest token (required)

Examples:

# Generate a guest token
akili superset guest-token daily-orders --user-id user-456

# Use in scripting (plain text token output)
TOKEN=$(akili superset guest-token daily-orders --user-id user-456)

# As JSON with expiry info
akili superset guest-token daily-orders --user-id user-456 --json

The token output includes the raw JWT token and its expiration time. In non-JSON mode, only the token string is printed to stdout (expiry goes to stderr), making it safe for shell variable capture.

---

akili superset deprovision <product>

Remove the Superset dashboard and dataset for a product. This is a destructive operation that requires the --confirm flag.

Arguments:

Argument	Type	Required	Description
product	string	yes	Product name or ID

Flags:

Flag	Short	Default	Description
--confirm		false	Confirm the destructive operation (required)

Examples:

# Attempt without confirmation (will fail)
akili superset deprovision daily-orders
# ERROR: Use --confirm to deprovision dashboard for 'daily-orders'

# Confirm deprovisioning
akili superset deprovision daily-orders --confirm

Caution

Deprovisioning permanently deletes the Superset dashboard. Saved charts, filters, and dashboard layout are not recoverable. The underlying data in the analytics store is not affected.

---

Dashboard Lifecycle

%%{init: {'flowchart': {'curve': 'basis'}}}%%
flowchart LR
    A[Product deployed with\nanalytics intent] --> B[akili superset provision]
    B --> C[Dashboard active]
    C --> D[Generate guest tokens\nfor embedding]
    C --> E[akili superset deprovision]
    E --> F[Dashboard removed]

Global Flags

All akili superset commands support these global flags:

Flag	Short	Default	Description
--json		false	Output as JSON instead of tables
--profile		default	Config profile to use
--api-url		from config	API base URL override
--timeout		30	Request timeout in seconds