> ## Documentation Index
> Fetch the complete documentation index at: https://docs.syncline.run/llms.txt
> Use this file to discover all available pages before exploring further.

# GET /v1/platform/dashboard

> Get platform usage stats and metrics

## Overview

Returns dashboard metrics for your platform including usage stats, connected users, and API limits.

## Authentication

Requires **Platform API Key** in the `X-API-Key` header.

## Request

```bash theme={null}
GET https://api.syncline.run/v1/platform/dashboard
```

## Response

```json theme={null}
{
  "platform": {
    "id": "plt_abc123",
    "name": "Your Platform Name",
    "email": "developer@yourplatform.com",
    "plan": "growth"
  },
  "usage": {
    "this_month": 347,
    "limit": 5000,
    "remaining": 4653,
    "can_schedule": true
  },
  "connected_users": 42,
  "stats": {
    "total_meetings_scheduled": 1247,
    "meetings_this_month": 347,
    "meetings_last_month": 298,
    "average_acceptance_time_hours": 4.2,
    "reschedule_rate": 0.08,
    "cancellation_rate": 0.03
  },
  "api_key_masked": "sk_live_abc...xyz"
}
```

## Response Fields

<ResponseField name="platform" type="object">
  Your platform information
</ResponseField>

<ResponseField name="usage" type="object">
  Current month usage statistics

  * `this_month`: Meetings scheduled this month
  * `limit`: Monthly meeting limit based on plan
  * `remaining`: Meetings remaining this month
  * `can_schedule`: Whether you can schedule more meetings
</ResponseField>

<ResponseField name="connected_users" type="integer">
  Number of users who have connected their calendars to your platform
</ResponseField>

<ResponseField name="stats" type="object">
  Historical performance metrics
</ResponseField>

## Example

```javascript theme={null}
const response = await fetch('https://api.syncline.run/v1/platform/dashboard', {
  headers: {
    'X-API-Key': process.env.SYNCLINE_API_KEY
  }
});

const dashboard = await response.json();

console.log(`Usage: ${dashboard.usage.this_month}/${dashboard.usage.limit}`);
console.log(`Connected users: ${dashboard.connected_users}`);
console.log(`Reschedule rate: ${(dashboard.stats.reschedule_rate * 100).toFixed(1)}%`);
```