SDK

The Bonnard SDK (@bonnard/sdk) is a lightweight TypeScript client for querying your deployed semantic layer programmatically. Build dashboards, embedded analytics, internal tools, or data pipelines — all backed by your governed metrics.

Quick start

npm install @bonnard/sdk

import { createClient } from '@bonnard/sdk';

const bonnard = createClient({
  apiKey: 'your-api-key',
});

const result = await bonnard.query({
  measures: ['orders.revenue', 'orders.count'],
  dimensions: ['orders.status'],
  timeDimension: {
    dimension: 'orders.created_at',
    granularity: 'month',
    dateRange: ['2025-01-01', '2025-12-31'],
  },
});

Type-safe queries

Full TypeScript support with inference. Measures, dimensions, filters, time dimensions, and sort orders are all typed. Query results include field annotations with titles and types.

const result = await bonnard.sql<OrderRow>(
  `SELECT status, MEASURE(revenue) FROM orders GROUP BY 1`
);
// result.data is OrderRow[]

What you can build

• Custom dashboards — Query your semantic layer from Next.js, React, or any frontend
• Embedded analytics — Add governed metrics to your product
• Data pipelines — Consume semantic layer data in ETL workflows
• Internal tools — Build admin panels backed by consistent metrics

See Also

• Overview — Platform overview
• querying.rest-api — Query format reference