Events API

Retrieve system events and activity logs

Events

Monitor system events and retrieve activity logs. The Events API provides real-time and historical event data.

GET /api/v1/events

Get recent system events with optional filtering by type, device, or time range.

Query Parameters

Parameter Type Description
type string Filter by event type
device_id string Filter by device ID
start_date datetime Start of time range
limit integer Max results (default: 100)

Response Example

{
  "events": [
    {
      "id": "evt_12345",
      "type": "access.granted",
      "device_id": "device_456",
      "user_id": "user_123",
      "timestamp": "2024-01-15T10:30:00Z",
      "metadata": {
        "location": "Main Entrance"
      }
    }
  ],
  "total": 1
}

Event Types

Available Event Types:

  • device.connected - Device comes online
  • device.disconnected - Device goes offline
  • access.granted - Access permission granted
  • access.denied - Access permission denied
  • alert.triggered - Security alert triggered
  • video.motion_detected - Motion detected on camera
  • system.error - System error occurred

Next: Webhooks

Learn how to configure webhooks for real-time event notifications

Continue to Webhooks →