Core concepts

Learn the small set of resources that make up every ReportPlane implementation.

Last verified 2026-08-02

Most ReportPlane workflows are combinations of the resources below. Learn these names first; the rest of the product will feel familiar.

Organization concepts

Account
Your personal identity. It holds your name, email, password, and workspace memberships.
Workspace
The top-level team and subscription boundary. Members, roles, plan limits, and shared security resources belong here.
Project
An isolated product or environment inside a workspace. Models, warehouses, clients, and analytics belong to a project.

Data concepts

Data model
A named schema that defines allowed fields, their types, required status, and time semantics.
Warehouse
The storage and compute system used for accepted data and analytics queries.
Destination
The relationship that sends one model's accepted records to a warehouse.
Credential
An encrypted connection secret used by ReportPlane to access an external warehouse or service.

Access concepts

Ingest client
A write identity. It defines allowed data models, protocol, authentication, and network restrictions.
Query client
A read identity. It defines allowed Analytics APIs, authentication, and network restrictions.
API key
A programmable identity that can have ingest capability, query capability, or both, with explicit resource scopes.
Management Token
A personal, expiring control-plane credential with project restrictions and explicit Management API scopes.
Client CA
A trusted certificate authority used to validate client certificates for mTLS.

Analytics concepts

Analytics API
A saved and published analytics definition. It describes dimensions, metrics, allowed filters, ordering, limits, and optional visualization metadata.
Dimension
A field used to group or label results, such as country, plan, or page path.
Metric
A numeric calculation such as count, sum, average, minimum, or maximum.
Filter
A controlled condition applied at query time. Published filter allowlists prevent callers from filtering arbitrary fields.
Explorer
An interactive workspace that uses the same analytics runtime to build and preview queries. It is not a separate query engine.

Alerting concepts

Alert
A governed Event Alert or Analytics Alert rule with severity, grouping, cooldown, and Notification Channels.
Incident
One open, acknowledged, or resolved lifecycle for an Alert and deterministic group.
Occurrence
A bounded sample or event reference merged into an Incident. The warehouse remains the full event history.
Notification Channel
A reusable Email, Generic Webhook, Slack, or Microsoft Teams delivery destination.

How the resources connect

Workspace
└── Project
    ├── Data model ── Destination ── Warehouse
    ├── Ingest client ── writes allowed models
    ├── Analytics API ── reads model data
    ├── Query client ── executes allowed analytics
    └── Alert ── Incident ── Notification Channel
Was this page helpful?Send feedback