Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.tarvah.com/llms.txt

Use this file to discover all available pages before exploring further.

The Tarvah SDK API lets you programmatically create dashboards with charts, experiments, and facades in a single API call. Instead of manually building dashboards through the UI, you can define your dashboard layout declaratively and import it via the SDK.

​
What you can do

Import Dashboards

Create complete dashboards with multiple charts in a single API call.

Authentication

Set up API key authentication for programmatic access.

Chart Types

Discover all supported chart types and aggregation functions.

Multi-Section Layouts

Build dashboards with KPI cards, category tabs, and custom templates.

​
How it works

  1. Create an API key from the Tarvah Settings UI
  2. Define your dashboard as a JSON payload with charts, measures, dimensions, and layout
  3. POST to /v1/sdk/import — the SDK creates experiments, a facade, and wires everything together
  4. View your dashboard in the Tarvah UI immediately

​
Two import modes

ModePayloadResult
Simple{ charts: [...] }1 experiment, 1 facade
Sections{ sections: [{ charts: [...] }] }N experiments (one per section), 1 facade

​
Base URL

https://<your-tarvah-instance>/v1/sdk