PulseWatch API reference

The PulseWatch API exposes the same data that powers your dashboards — monitored services, detected incidents, 15-minute metric buckets, and alert configuration — behind a single authenticated HTTPS endpoint.

All requests hit a single dispatch endpoint. The operation is chosen via theendpoint field in the JSON body — for example "services.list" or"incidents.current".

1. 1

   Create an API key

   Go to Dashboard → API keys and generate a new key. Keys start with pw_live_ and are shown exactly once.

2. 2

   Make your first request

   Every call is a POST with a JSON body and a Bearer token. Start with services.list:

curl -X POST https://your-app.base44.app/functions/publicApi \
  -H "Authorization: Bearer pw_live_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{"endpoint": "services.list"}'

3. 3

   Wire up alerts (optional)

   Create an Alert rule in the dashboard and point it at a webhook URL to receive incident lifecycle events directly.

Authenticate every request with a Bearer token. Generate and revoke keys from theAPI keyspage. Full keys are shown only at creation time — if lost, revoke and regenerate.

Authorization: Bearer pw_live_<32 characters>

Limits apply per API key. Both per-minute request caps and monthly request quotas are enforced.

When limits are exceeded, the API returns 429 Too Many Requests. Back off exponentially and retry after the rate window resets (per-minute windows are 60 seconds).

List endpoints accept an optional limit (incidents.history up to 500, metrics.buckets up to 288). Cursor pagination is not available yet: narrow the window with the endpoint's own filters instead of paging.

{
  "endpoint": "incidents.history",
  "limit": 100
}

Read data about every service PulseWatch monitors.

{
  "endpoint": "services.list"
}

{
  "services": [
    {
      "id": "svc_aws",
      "name": "AWS",
      "slug": "aws",
      "category": "cloud",
      "currentStatus": "normal",
      "baselinePerHour": 12
    }
  ]
}

{
  "endpoint": "services.get",
  "slug": "stripe"
}

{
  "service": {
    "id": "svc_stripe",
    "name": "Stripe",
    "slug": "stripe",
    "currentStatus": "possible_issue",
    "category": "payments"
  }
}

Incidents represent detected disruptions with start, end, severity, and confidence scores.

{
  "endpoint": "incidents.current"
}

{
  "incidents": [
    {
      "id": "inc_123",
      "serviceId": "svc_stripe",
      "serviceName": "Stripe",
      "status": "major_issue",
      "severity": "high",
      "startedAt": "2026-04-23T14:32:11Z",
      "peakReports": 189,
      "confidenceScore": 0.82
    }
  ]
}

{
  "endpoint": "incidents.history",
  "serviceId": "svc_stripe",
  "limit": 50
}

{
  "incidents": [
    {
      "id": "inc_98",
      "status": "resolved",
      "severity": "medium",
      "startedAt": "2026-04-20T09:10:00Z",
      "endedAt": "2026-04-20T09:48:00Z",
      "peakReports": 412
    }
  ],
  "next_cursor": null
}

Detection metrics for any service, aggregated into 15-minute buckets with baseline and severity scores.

{
  "endpoint": "metrics.buckets",
  "serviceId": "svc_stripe",
  "limit": 96
}

{
  "data": [
    {
      "serviceId": "svc_stripe",
      "pointInTime": "2026-04-23T14:00:00Z",
      "intervalMinutes": 15,
      "totalReports": 42,
      "uniqueSessions": 31,
      "baselineValue": 8,
      "severityScore": 5.25
    }
  ]
}

Watchlists group services together so you can focus dashboards and alerts on the dependencies that matter to you.

{
  "endpoint": "watchlists.list"
}

{
  "watchlists": [
    {
      "id": "wl_1",
      "name": "Production stack",
      "serviceIds": ["svc_stripe", "svc_aws"]
    }
  ]
}

Alert rules are configured in the dashboard. Use the API to audit or script rule state.

{
  "endpoint": "alerts.rules.create",
  "serviceId": "svc_stripe",
  "deliveryChannel": "email",
  "thresholdType": "major_issue"
}

{
  "data": {
    "id": "ar_1",
    "serviceId": "svc_stripe",
    "deliveryChannel": "email",
    "thresholdType": "major_issue",
    "enabled": true
  }
}

All errors return a structured JSON body with an error code and a human-readable message. Always log both.

{ "error": "quota_exceeded", "message": "Monthly quota of 100,000 exceeded. Upgrade your plan or wait until next cycle." }