Skip to main content

getDashboardOverview()

getDashboardOverview(): Promise<DashboardOverview>

Defined in: packages/core/src/index.ts:3309

Get dashboard overview with summary statistics

Returns​

Promise<DashboardOverview>

Dashboard overview with key metrics

Throws​

401 - Not authenticated

Example​

import { getDashboardOverview } from "@cpod/sdk";

const overview = await getDashboardOverview();
console.log(`Total users: ${overview.total_users}`);
console.log(`Active projects: ${overview.active_projects}`);