Luzmo provides a comprehensive set of APIs to help you build powerful embedded analytics solutions. This guide provides an overview of all available resources and services, organized by functionality.
Before using the Luzmo API, you'll need to:
Obtain API credentials - Create an API key-token pair in your Luzmo profile
Understand authentication - Learn how to connect to the API
Review the schema - Familiarize yourself with the API schema
Learn the actions - Understand the available API actions
Core resources are the fundamental building blocks of the Luzmo platform. Each resource supports standard actions like create , search , update , delete , associate , and dissociate .
| Resource | Description | Actions |
|---|---|---|
| Authorization | Generate embed tokens for providing your application's users secure access to dashboards and datasets. Required for all client-side embedding. | Create · Search · Delete |
| EmbedFilterGroup | Parameterized filter configurations for datasets. Each organization can have a single embed filter group for multi-tenant filtering. | Create · Search · Associate · Dissociate |
Dashboards and datasets are both types of "securables" in Luzmo's API.
| Resource | Description | Actions |
|---|---|---|
| Dashboard | Dashboards containing visualizations. Access via the securable endpoint with type: "dashboard" . | Create · Search · Update · Delete · Associate · Dissociate |
| Dashboard Version | Dashboard version history. Access, publish, and restore previous versions. | Search · Update |
| Collection | Dashboard/dataset collections (folders). Organize dashboards and datasets into groups without nesting. | Create · Search · Update · Delete · Associate · Dissociate |
| Tag | Labels for organizing resources. Tag dashboards and datasets for easy filtering and discovery. | Create · Search · Associate · Dissociate |
| Dataset | Datasets containing data for visualizations. Access via the securable endpoint with type: "dataset" . | Create · Search · Update · Delete · Associate · Dissociate |
| Column | Dataset columns defining the data structure. Includes metadata like data type, format, and derived column expressions. | Validate · Create · Search · Update · Delete · Associate · Dissociate |
| Acceleration | Query performance optimization (Warp). Periodically synchronize data from source to Luzmo's analytics-optimized warehouse. Supports full syncs and delta syncs. | Create · Search · Update · Delete · Associate |
| Resource | Description | Actions |
|---|---|---|
| User | User accounts within an organization. Manage access, roles, and permissions. | Create · Search · Update · Delete · Associate · Dissociate |
| Group | User groups for bulk permission management. Assign dashboard/dataset access to multiple users at once. | Create · Search · Update · Delete · Associate · Dissociate |
| Organization | Organization management. Configure billing details, organization name, logo, and settings. | Create · Search · Update · Delete · Associate · Dissociate |
| SSOConfig | Single sign-on configuration using OIDC protocol. Set up SSO for in-app users (embed users are authenticated by your own system). | Create · Search · Update · Delete |
| Resource | Description | Actions |
|---|---|---|
| Formula | Calculated fields and custom expressions for aggregated calculations. Supports AVG, COUNT, SUM, MIN, MAX, and more. | Validate · Create · Search · Update · Delete · Associate · Dissociate |
| Hierarchy Level | Individual levels within a data hierarchy. Configure level-specific settings for drill-down functionality. | Create · Search · Update · Delete · Associate · Dissociate |
| Resource | Description | Actions |
|---|---|---|
| Account | Data source connections using credentials. Connect to databases, plugins, and web services to import datasets. | Create · Search · Update · Delete · Associate |
| Plugin | Custom data source connectors. Extend Luzmo with proprietary data integrations. | Create · Search · Update · Delete · Associate · Dissociate |
| Resource | Description | Actions |
|---|---|---|
| Theme | Visual styling for dashboards and charts. Control colors, fonts, and overall appearance. | Create · Search · Update · Delete · Associate · Dissociate |
| Locale | Language and regional settings. Configure localization preferences for users, organizations, and tokens. | Search · Associate · Dissociate |
| Country | Geographic region settings. Used for locale and compliance configuration. | Search · Associate · Dissociate |
| Resource | Description | Actions |
|---|---|---|
| Alert | Data-driven notifications. Trigger alerts based on metric thresholds via email, Slack, webhooks, or SMS. | Create · Search · Update · Delete · Associate · Dissociate |
| Channel | Communication channels for alerts. Configure email, Slack, webhooks, and other notification destinations. | Create · Search · Update · Delete · Associate · Dissociate |
| Schedule | Automated tasks scheduled on a periodic basis. Includes alerts, exports, and acceleration syncs. | Create · Search · Update · Delete · Associate · Dissociate |
| Share | Public sharing links for dashboards. Often used for quick testing purposes (no authentication required). Each share has its own usage statistics. | Create · Search · Delete · Associate · Dissociate |
Services are specialized endpoints that perform specific operations rather than managing resources.
| Service | Description | Actions |
|---|---|---|
| Data | Query and push data to datasets. Supports aggregations, filters, and multi-query requests. | Create (push) · Get (query) · Update (signal changes) |
| Dataprovider | List and create datasets from connected data sources. Import datasets from databases, plugins, or web services. | Create · Get |
| Hierarchy | Manage data hierarchies for drill-down functionality. Define parent-child relationships, translations, and data-driven colors. | Get · Update · Delete |
| Service | Description | Actions |
|---|---|---|
| Export | Generate PDF, PNG, or CSV exports of dashboards and charts. Can be immediate or scheduled. | Create · Search · Delete |
| Dataexport | Asynchronous large file exports. Generate CSV or Excel exports sent to the user's email address. | Create |
| Service | Description | Actions |
|---|---|---|
| AI Chart | AI-generated chart suggestions. Get visualization recommendations based on dataset structure and optional prompts. | Create |
| Generate Descriptions | AI-generated descriptions for datasets, columns, and formulas. | Create |
The Luzmo API implements rate limiting to ensure fair usage. See the Rate Limiting guide for details.
Luzmo IQ is the AI-powered data assistant that enables natural language queries and intelligent data insights. Learn more in the IQ API Introduction .
| Resource | Description | Actions |
|---|---|---|
| IQConversation | Luzmo IQ conversations. Each conversation contains multiple messages and maintains context. | Create · Search · Delete |
| IQMessage | Individual messages in an IQ conversation. Create messages to prompt IQ and receive streamed responses. | Create · Search · Delete |
| IQFormula | AI-suggested formulas. Generate derived column expressions or formulas using natural language prompts. | Create |
Build custom data source connectors to extend Luzmo with proprietary data integrations. The Plugin API allows you to create connectors for databases, APIs, or any data source not natively supported.
| Topic | Description |
|---|---|
| Introduction | Overview of Luzmo plugins and their capabilities |
| Registering a Plugin | How to register your plugin in Luzmo |
| Plugin Endpoints | HTTP endpoints your plugin should expose |
| Webhooks | Plugin webhook configuration |