Skip to main content

Get Dashboard Metrics

GET 
/api/v1/account/dashboard/metrics

Get dashboard KPI metrics for the authenticated user.

Returns key performance indicators for the dashboard:

  • Active Workflows: Workflows that are active and were created or executed in the period
  • Events Total: Total geofence entry/exit events triggered in the period
  • Action Delivery Success: Success rate for webhook deliveries and workflow step executions (north-star metric)

Time Ranges:

  • today: From midnight to now
  • 7d: Last 7 days
  • 30d: Last 30 days
  • custom: Custom date range (requires start_date and end_date)

Formulas:

  • Action Delivery Success Rate = (successful_deliveries / total_attempts) * 100
  • Returns null when total_attempts = 0 (UI should show "—")

Authentication: JWT token required

Example:

GET /api/v1/accounts/dashboard/metrics?time_range=7d
GET /api/v1/accounts/dashboard/metrics?time_range=custom&start_date=2025-01-01T00:00:00Z&end_date=2025-01-31T23:59:59Z

Dashboard UX: Ticket #2 - Global Time-Range Control + KPI Formulas

Request​

Responses​

OK