Developer API Reference

Complete REST and Server-Sent Events API reference for telemetry ingestion and querying.

CONNECTING

Status Page

API Key Authentication

All telemetry ingestion endpoints authenticate requests using a Bearer token in the Authorization header:

Authorization: Bearer pb_live_••••••••••••••••••••••••

POST/api/heartbeat

Auth: Bearer <PULSEBOARD_API_KEY>

Ingest Service Heartbeat

Send telemetry pings containing response latency, HTTP status codes, and optional CPU/memory usage.

Request Body (JSON)

{
  "serviceId": "docrev-api",
  "responseTime": 64,
  "statusCode": 200,
  "cpuUsage": 42.5,
  "memoryUsage": 68.1,
  "region": "us-east-1"
}

Example Response

{
  "success": true,
  "service": {
    "id": "service-cuid",
    "name": "DocRev API",
    "status": "healthy",
    "currentLatency": 64,
    "uptimePercentage": 99.98
  },
  "metric": {
    "id": "metric-cuid",
    "responseTime": 64,
    "statusCode": 200,
    "timestamp": "2026-08-14T18:00:00.000Z"
  }
}

GET/api/services

Auth: Cookie Session or API Key

List All Registered Services

Retrieve all monitored services with their current health statuses, latency, and uptime SLA.

Example Response

{
  "services": [
    {
      "id": "cuid_1",
      "name": "DocRev API",
      "slug": "docrev-api",
      "status": "healthy",
      "currentLatency": 82,
      "uptimePercentage": 99.98,
      "totalRequests": 284921
    }
  ]
}

GET/api/metrics?range=24h&serviceId=docrev-api

Auth: Cookie Session

Query Aggregated Metrics

Fetch time-bucketed telemetry data points and global KPI counters for charts.

Example Response

{
  "chartData": [
    {
      "timestamp": "2026-08-14T17:00:00.000Z",
      "timeLabel": "05:00 PM",
      "requests": 2840,
      "errors": 2,
      "errorRate": 0.07,
      "latency": 78
    }
  ],
  "kpis": {
    "totalRequests": 284921,
    "uptimePercentage": 99.98,
    "avgLatency": 82
  }
}

GET/api/events

Auth: Public / Session Stream

Server-Sent Events (SSE) Stream

Subscribe to real-time telemetry broadcasts, automated incident triggers, and release notifications.

Example Response

data: {"channel":"pulse:heartbeat","payload":{"serviceName":"DocRev API","responseTime":74,"status":"healthy"}}

{ "success": true, "service": { "id": "service-cuid", "name": "DocRev API", "status": "healthy", "currentLatency": 64, "uptimePercentage": 99.98 }, "metric": { "id": "metric-cuid", "responseTime": 64, "statusCode": 200, "timestamp": "2026-08-14T18:00:00.000Z" } }

{ "services": [ { "id": "cuid_1", "name": "DocRev API", "slug": "docrev-api", "status": "healthy", "currentLatency": 82, "uptimePercentage": 99.98, "totalRequests": 284921 } ] }

{ "chartData": [ { "timestamp": "2026-08-14T17:00:00.000Z", "timeLabel": "05:00 PM", "requests": 2840, "errors": 2, "errorRate": 0.07, "latency": 78 } ], "kpis": { "totalRequests": 284921, "uptimePercentage": 99.98, "avgLatency": 82 } }