Skip to content
Golden ReportsDocs
v0.2.13

Beautiful reports, driven by your data.

Everything you need to design, connect, and run data-driven reports. From your first template to multi-source data contexts.

Get started
<section class="report">
  <h1>{{ report.title }}</h1>
  <p class="subtitle">{{ report.date }}</p>


  <gr-table source="orders">
  </gr-table>
</section>

Introduction

Welcome to Golden Reports

Golden Reports is a platform for designing, generating, and operating data-driven reports - invoices, statements, shipping labels, financial statements, and operational dashboards. Build visually, wire to live data, export or embed anywhere.

Golden Reports is a platform for designing, generating, and operating data-driven reports - from invoices and shipping labels to financial statements and operational dashboards. Build reports visually inside the Manager, wire them to your data, and export or embed them anywhere.

What is Golden Reports?

A short tour of the platform - who it's for and what it does.

Core concepts

The vocabulary of reports, blocks, data sources, contexts, parameters, and queries.

Quick start

Build your first report end-to-end in about ten minutes.

The report editor

Tour the visual editor: panels, the design surface, layers, and pages.

How to read these docs

The documentation is written for two audiences:

  • Report authors and operators - product managers, finance teams, operations, customer success. You'll spend most of your time in Building reports, Data, and Collaboration.
  • Engineers and platform owners - backend developers, SREs, anyone integrating Golden Reports or self-hosting it. Architecture, Self-hosting, and Building extensions are written for you.

The sidebar on the left is grouped by audience need rather than by product surface, so a non-technical reader can follow the introduction → building → data path without ever needing to read an operator-focused page.

Looking for API references?

API references - GraphQL schema, embed URLs, and SDK references - live on the separate Developer Portal. These docs cover concepts, workflows, architecture, and operations.

What you can do with Golden Reports

  • Design pixel-accurate reports visually in the Manager's report editor. Templates are HTML + Liquid; a library of built-in blocks (tables, charts, KPIs, barcodes, QR codes, gauges, page headers and footers, and more) covers the harder reporting and print concerns out of the box.
  • Query live data through a data context - a versioned GraphQL schema your authors write against without ever seeing the underlying databases.
  • Export the same report to PDF, embed it in your product, or run it on demand from a third-party system.
  • Reuse themes, assets, and connectors across an entire organization.
  • Self-host the whole stack on Kubernetes with the official Helm chart, or run it as a managed service.
  • Extend the platform with custom blocks and custom data connectors.

Where to next

If you're new, start with What is Golden Reports and then walk through the Quick start. If you already know what the platform does and want to wire it up, jump straight to Data sources. If you're evaluating self-hosting, Deployment overview is the right entry point.

Next
What is Golden Reports