DashboardMetricsResponse

Dashboard metrics response schema.

time_rangeTime Range (string)required

Time range: today, 7d, 30d, or custom

period_startstring<date-time>required

Start of the period

period_endstring<date-time>required

End of the period

active_workflowsActive Workflows (integer)required

Number of active workflows in period

events_totalEvents Total (integer)required

Total geofence events (entry/exit) in period

action_delivery_success objectrequired

Action delivery success metrics (north-star KPI)

rate object

Success rate percentage (0-100) or null if no data

anyOf

• number
• null

number

successfulSuccessful (integer)required

Number of successful action deliveries

totalTotal (integer)required

Total number of action attempts

comparison objectrequired

Comparison vs previous period

events_changeEvents Change (integer)required

Absolute change in events vs previous period

workflows_changeWorkflows Change (integer)required

Absolute change in active workflows vs previous period

success_rate_change object

Percentage point change in success rate

anyOf

• number
• null

number

DashboardMetricsResponse

{
  "time_range": "string",
  "period_start": "2024-07-29T15:51:28.071Z",
  "period_end": "2024-07-29T15:51:28.071Z",
  "active_workflows": 0,
  "events_total": 0,
  "action_delivery_success": {
    "rate": 0,
    "successful": 0,
    "total": 0
  },
  "comparison": {
    "events_change": 0,
    "workflows_change": 0,
    "success_rate_change": 0
  }
}