> ## Documentation Index
> Fetch the complete documentation index at: https://docs.5x.co/llms.txt
> Use this file to discover all available pages before exploring further.

# Overview

> Build and manage metrics data models using Cube.js to define business metrics and enable consistent analytics across your organization

**Focus:** Learn how to create and manage metrics data models (Cubes) that provide a unified layer for defining business metrics, enabling consistent analytics across all your tools and applications.

The Metrics Store is a comprehensive metrics layer solution built on **Cube.js** technology that enables you to create and manage data models called **Cubes**. These cubes define business metrics and dimensions, providing a standardized way to access your data through SQL and REST APIs, and integrate seamlessly with BI tools.

<Note>
  **Powered by Cube.js**

  The Metrics Store is built on Cube.js, the leading open-source metrics layer platform. We've integrated it deeply with the 5X platform to provide seamless project management, deployment options, and BI tool integration.
</Note>

## What are cubes?

**Cubes** are pre-built data models that contain:

* **Measures**: Quantitative metrics like revenue, orders, users, or any calculated business KPIs
* **Dimensions**: Attributes for analysis like date, region, product category, or customer segment
* **Time dimensions**: Special dimensions for time-based analysis and period-over-period comparisons

Cubes provide a standardized way to define business metrics and enable consistent analytics across your organization. Define once, use everywhere.

## Core capabilities

### **Project management**

Create and manage multiple Cube projects with Git-based version control:

* **Platform managed repositories** - 5X-managed Git repositories for easy setup
* **Imported repositories** - Connect your existing GitHub repositories
* **Branch management** - Work with multiple branches for different environments or features
* **Project settings** - Configure deployment options, protected branches, and environments

### **Cube Playground**

Interactive development environment for building and testing cubes:

* **Visual query builder** - Drag-and-drop interface for building queries
* **SQL editor** - Direct SQL query execution and testing
* **Data exploration** - Explore cubes, measures, and dimensions interactively
* **Schema management** - Define and edit cube schemas using YAML or JavaScript

### **API access**

Query your cubes through multiple interfaces:

* **SQL API** - PostgreSQL-compatible connection for BI tools and SQL clients
* **REST API** - RESTful API access for application integration
* **Real-time calculations** - Compute metrics on-demand with fresh data
* **Connection credentials** - Secure, managed credentials for API access

### **BI integration**

Automatically sync cube definitions with BI tools:

* **Native connectors** - Support for Metabase
* **Automatic synchronization** - Keep metric definitions current across tools
* **Individual or bulk sync** - Sync specific connections or all at once
* **Status tracking** - Monitor sync status and last sync time per connection

### **Deployment options**

Configure when your Cube service runs:

* **Always on** - Continuous operation for production environments
* **On demand** - Start when needed for development or testing
* **Scheduled** - Time-based or cron-based scheduling

## Getting started

Ready to create your first Cube project? Here's how to get started:

### **Step 1: Navigate to Metrics Store**

1. Go to the **Metrics Store** page (`/metrics-store`)
2. Or click **"Metrics Store"** from the navigation menu

### **Step 2: Create your first project**

If no projects exist, you'll see a **"Create project"** button. Otherwise, use the project dropdown and select **"New project"**.

<Card title="Getting Started Guide" icon="rocket" href="/core-features/metric-store/getting-started">
  **Quick start in 5 minutes**

  Step-by-step guide to creating your first Cube project and defining your first cubes.
</Card>

## Core documentation

Explore the comprehensive guides to master the Metrics Store:

<CardGroup cols={2}>
  <Card title="Getting Started" icon="rocket" href="/core-features/metric-store/getting-started">
    **Create your first project**

    Quick start guide to creating your first Cube project and accessing the Cube Playground.
  </Card>

  <Card title="Project Management" icon="folder" href="/core-features/metric-store/project-management">
    **Manage projects and branches**

    Learn how to create, edit, and manage Cube projects with Git-based version control.
  </Card>

  <Card title="Cube Playground" icon="code" href="/core-features/metric-store/cube-playground">
    **Build and test cubes**

    Master the Cube Playground interface for building queries and defining cube schemas.
  </Card>

  <Card title="API Credentials" icon="key" href="/core-features/metric-store/api-credentials">
    **Access your data**

    Learn how to get SQL and REST API credentials for connecting BI tools and applications.
  </Card>

  <Card title="BI Integration" icon="link" href="/core-features/metric-store/bi-integration">
    **Sync with BI tools**

    Set up automatic synchronization of cube definitions with your BI tools.
  </Card>

  <Card title="Deployment Options" icon="settings" href="/core-features/metric-store/deployment-options">
    **Configure deployment**

    Understand deployment modes and scheduling options for your Cube service.
  </Card>
</CardGroup>

## Key benefits

### **Single source of truth**

Define business metrics once in Cube schemas and use them consistently across all your analytics tools. Eliminate discrepancies between different reports and dashboards.

### **Flexible development workflow**

* **Git-based version control** - Track changes, collaborate, and manage cube definitions
* **Branch-based development** - Work on features in separate branches
* **Schema as code** - Define cubes using YAML or JavaScript files
* **Testing and validation** - Test queries in Cube Playground before deploying

### **Universal access**

Make your cubes available through multiple interfaces:

* **SQL API** - Connect any SQL-compatible tool or client
* **REST API** - Integrate with custom applications
* **BI tools** - Native connectors for popular analytics platforms
* **Real-time queries** - Compute metrics on-demand with current data

## Integration with core features

The Metrics Store enhances all other 5X capabilities:

* **Data Warehousing**: Cubes query your warehouse directly for real-time calculations
* **Business Intelligence**: BI tools connect to Metrics Store for consistent metrics
* **Data & AI Apps**: Applications access standardized metrics through APIs
* **Conversational AI**: Natural language queries use Metrics Store definitions
* **Orchestration**: Cube projects can be managed through workflow automation

## Common use cases

### **Executive reporting**

Ensure leadership sees consistent numbers:

* **KPI standardization** across all executive dashboards and reports
* **Period-over-period analysis** with consistent time-based calculations
* **Goal tracking** comparing actual performance to targets
* **Board presentation** materials with verified, consistent metrics

### **Self-service analytics**

Empower business users with trusted metrics:

* **Metric discovery** helping users find the right data for their questions
* **Confidence in results** knowing all metrics follow approved business logic
* **Reduced IT burden** fewer requests for custom reports and analysis
* **Guided exploration** suggesting relevant metrics and dimensions

### **Cross-functional collaboration**

Enable teams to work with shared definitions:

* **Sales and marketing alignment** on lead and conversion metrics
* **Finance and operations** using the same cost and efficiency calculations
* **Product and engineering** sharing user engagement and performance metrics
* **Customer success** teams accessing consistent customer health scores

***

<CardGroup cols={2}>
  <Card title="New to 5X?" icon="rocket" href="/quickstart">
    **Start with quickstart**

    Get your workspace running and see Metrics Store in action in 15 minutes.
  </Card>
</CardGroup>