Custom reports

The Custom Report Builder provides an interactive analytics environment modeled directly after the Cube.js Playground, allowing operators and administrators to construct tailored analytical queries, visualize metrics, and inspect underlying query models.

Query Builder (Playground Interface)

The report builder is organized into color-coded semantic zones:

1. Measures (Purple)

Numerical and aggregated metrics computed across your store’s transactions and activities:

• Click + Add Measure to browse metrics grouped by data models (e.g. Orders Total Amount, Orders Count, Orders Average Order Duration). Each measure displays its description and Cube field identifier to help you select the exact calculation you need.
• Remove measures by clicking the ✕ on each pill badge.

2. Dimensions (Blue)

Categorical attributes used to break down, segment, and group your data:

• Click + Add Dimension to select attributes across stores, categories, products, variants, staff, and external brands.
• Transpose dimensions into rows or pivot columns using the Pivot Settings tool.

3. Segments (Green)

Predefined filtering scopes defined within the Cube data models:

• Quickly filter by statuses such as Paid Orders, Voided Orders, Regular Orders, or Regular Payments.

4. Time Dimensions (Amber)

Temporal analysis controls:

• Enable Time Dimension: Toggle date-based grouping.
• Field: Select the relevant timestamp field (e.g., Orders Paid At, Orders Paid At (Operating Hours), Line Items Created At, Orders Opened At).
• Granularity: Group records daily, weekly, monthly, or yearly.

5. Filters (Deep Orange)

Interactive conditional filters:

• Click + Add Filter to filter any dimension or measure by operators:
  • Equals (=)
  • Does Not Equal (!=)
  • Greater Than (>)
  • Less Than (<)
  • Is Set (is not null)
  • Is Not Set (is null)

6. Order & Limit Controls

• Order: Select a primary measure or dimension to sort results, with a toggle for Ascending (▲) or Descending (▼) ordering.
• Limit: Choose maximum result rows (50, 100, 500, 1000, 5000).
• Pivot: Configure cross-tabulation across X (Rows) and Y (Columns).

---

Visualization & Inspection Workspace

Below the query builder, the workspace offers multi-tab inspection:

• Preview:
  • Table View: Full tabular data view with pivot calculations, sorting, and export capabilities.
  • Bar Chart: Visual bar comparison across categories or time intervals.
  • Line Chart: Continuous trend analysis for time-series metrics.
• JSON Query: Real-time display of the compiled Cube.js REST payload (measures, dimensions, filters, timeDimensions, order, limit) with one-click Copy JSON functionality for debugging.