@orchestree/analytics

Analytics and dashboard builder for Orchestree. Create dashboards, track KPIs, generate reports, and visualize metrics.

Installation

npm install @orchestree/analytics

Quick Start

const { AnalyticsClient } = require('@orchestree/analytics');

const client = new AnalyticsClient({
  apiKey: 'your-api-key',
});

// Create dashboard
const dashboard = await client.createDashboard({
  name: 'Sales Dashboard',
  description: 'Q2 sales metrics',
});

// Add chart
const chart = await client.addChart(dashboard.id, {
  type: 'line',
  title: 'Revenue Trend',
  metric: 'revenue',
});

// Track KPI
const kpi = await client.trackKPI({
  name: 'Monthly Revenue',
  value: 50000,
  target: 75000,
});

// Generate report
const report = await client.generateReport('sales', {
  period: 'Q2',
});

API Reference

AnalyticsClient

createDashboard(dashboardDef)

Create a new dashboard.

const dashboard = await client.createDashboard({
  name: 'Executive Dashboard',
  description: 'KPIs and metrics',
});

addChart(dashboardId, chartDef)

Add a chart to dashboard.

const chart = await client.addChart(dashboard.id, {
  type: 'bar',
  title: 'Monthly Sales',
  metric: 'sales',
});

trackKPI(kpiDef)

Track a KPI.

await client.trackKPI({
  name: 'Customer Acquisition Cost',
  value: 45,
  target: 35,
  unit: 'USD',
});

generateReport(reportType, options)

Generate a report.

const report = await client.generateReport('performance', {
  startDate: '2024-04-01',
  endDate: '2024-04-30',
});

License

MIT