Public API (Scale+)

Read-only HTTP API for latest briefing, open insights, and health — Scale and Enterprise tiers.

Hollow Sentinel exposes a small read-only API for Scale+ merchants. Generate an API key in Settings → Public API, then call the endpoints below with your shop domain.

Authentication

Send Authorization: Bearer <your-api-key> and include ?shop=your-store.myshopify.com on every request. Generate or revoke keys in Hollow Sentinel Settings → Public API (Scale+).

Endpoints

  • GET /api/v1/health?shop=… — overall health score and dimension summary
  • GET /api/v1/briefing/latest?shop=… — most recent daily briefing payload
  • GET /api/v1/insights?shop=… — open insights with severity and confidence

Enterprise exports

Enterprise merchants can download CSV audit exports from Settings (insights dismissed/snoozed, briefing deliveries, timeline events) subject to tier retention windows.

Was this page helpful?