Lockally

      Use your API key in the examples

      Replaces lk_live_… in the code samples on this site so you can copy and run them. It is stored in this browser only and is never sent anywhere, including to Ask AI.

      It will be visible on the page. Use a test key if you are sharing your screen or taking screenshots.

      Analytics and events

      Usage, health, activity and the delivery event feed.

      Every endpoint needs Authorization: Bearer lk_live_.... See Conventions for headers, status codes and error shape.

      Audit summary for the dashboard

      GET /v1/audit-summary  ·  scope tenant:read

      Response 200

      Audit summary

      Field Type Notes
      admin_actions_today integer
      recent_logins array of AuditEvent
      recent_exports array of AuditEvent
      deleted_mailboxes array of AuditEvent
      generated_at string

      Errors: 401, 403

      Domain health status for the dashboard

      GET /v1/domains/status  ·  scope tenant:read

      Response 200

      Domain health status

      Field Type Notes
      domains array of object
      generated_at string

      Errors: 401, 403

      Full tenant health report

      GET /v1/health  ·  scope tenant:read

      Response 200

      Full tenant health report

      Field Type Notes
      overall_score integer Required.
      checks array of TenantHealthCheck Required.
      generated_at string Required.

      Errors: 401, 403

      Integrations summary for the dashboard

      GET /v1/integrations-summary  ·  scope tenant:read

      Response 200

      Integrations summary

      Field Type Notes
      api_requests_today integer
      active_api_keys integer
      api_keys array of object
      webhook_failures integer
      webhooks_total integer
      webhooks array of object
      generated_at string

      Errors: 401, 403

      Security overview for the dashboard

      GET /v1/security  ·  scope tenant:read

      Response 200

      Security overview

      Field Type Notes
      overall_status string (healthy, warning, critical)
      stats array of object
      alerts array of object

      Errors: 401, 403

      Storage usage for the dashboard

      GET /v1/storage  ·  scope tenant:read

      Response 200

      Storage usage

      Field Type Notes
      total_bytes integer
      alloc_bytes integer
      per_seat_bytes integer
      top_mailboxes array of object
      top_messages array of object
      generated_at string

      Errors: 401, 403

      User insights for the dashboard

      GET /v1/user-insights  ·  scope tenant:read

      Response 200

      User insights

      Field Type Notes
      recently_added array of UserEvent
      recently_suspended array of UserEvent
      inactive_30d array of UserEvent
      seats_used integer
      seats_alloc integer
      seats_capped boolean True only on tiers with a hard seat cap (Free, Founder). On unlimited/per-seat tiers seats_alloc merely tracks the live mailbox count, so seats_used == seats_alloc is normal and must not be read as ‘at capacity’.
      generated_at string

      Errors: 401, 403