steedos-questions

Generate MBQL-based analytics question seed files (.question.yml) for Steedos projects.

1.6k|413|Updated Mar 4, 2019
One-click install
npx skills add https://github.com/steedos/steedos-platform --skill steedos-questions
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: steedos-questions
Source: https://github.com/steedos/steedos-platform/tree/main/skills/steedos-questions
Command: npx skills add https://github.com/steedos/steedos-platform --skill steedos-questions

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Create analytics question files (.question.yml) in Steedos projects. Questions are report/chart definitions stored as YAML seed data files, based on the @steedos-labs/analytics package (Metabase engine). Covers file format, dataset_query structure (MBQL), display types, visualization_settings, result_metadata, and file naming conventions.

Core Features & Use Cases

  • File Location & Naming: <package>/main/default/questions/<question-name>.question.yml
  • File Structure: name, created_at, creator_id, database_id, dataset_query, display, id, entity_id, result_metadata, table_id, visualization_settings
  • Supported Queries & Visualizations: scalar, bar, table, and other display types using MBQL definitions.

Quick Start

Create a new questions seed under the package's questions directory and define its metadata and MBQL query, then commit to the repo.

Frequently Asked Questions about steedos-questions

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I define analytics questions in Steedos projects?▼

To define analytics questions in Steedos projects, you generate MBQL-based seed files (.question.yml) under the package's main/default/questions/ directory to formalize data queries and visualizations.

What format is required for Steedos analytics question seed files?▼

Steedos analytics question seed files use the .question.yml format, requiring fields like name, created_at, dataset_query, display, id, and visualization_settings with proper 24-character ObjectIds and JSON strings.

Does the Steedos analytics engine support MBQL aggregations and breakouts?▼

Yes, the Metabase-like engine supports MBQL definitions including data aggregations, breakouts, and filters to generate various visualization types like scalar, bar, and table displays.

What display types can I configure for Steedos data queries?▼

You can configure scalar, bar, and table display types for Steedos data queries by specifying the display field and visualization_settings within your .question.yml seed file.

Why do my Steedos question YAML files fail during data queries?▼

Steedos question YAML files fail if they omit required metadata fields like entity_id, result_metadata, or database_id, or if ObjectIds are not properly formatted as 24-character JSON strings.