Skip to main content

OverviewOut

badges objectrequired
incidents_openIncidents Open (integer)required
dlq_pending object

Null unless the caller is a workspace owner or manager.

anyOf
integer
integrations_degradedIntegrations Degraded (integer)required
incidents object[]required
  • Array [
    • idstring<uuid>required
    signal_typeSignal Type (string)required
    source_idsstring[]required
    severitySeverity (string)required
    opened_atstring<date-time>required
    acknowledged_at object
    anyOf
    string<date-time>
    acknowledged_by object
    anyOf
    string<uuid>
    muted_until object
    anyOf
    string<date-time>
    owner_id object
    anyOf
    string<uuid>
    resolved_at object
    anyOf
    string<date-time>
    payload objectrequired
    property name*any
    statusStatus (string)required
  • ]
    • dashboard_stats objectrequired
    active_device_countActive Device Count (integer)required
    live_countLive Count (integer)required
    reporting_countReporting Count (integer)required
    offline_stale_countOffline Stale Count (integer)required
    expected_reporting_countExpected Reporting Count (integer)required
    attention_countAttention Count (integer)required
    parked_countParked Count (integer)required
    reporting_window_minutesReporting Window Minutes (integer)required
    paused_countPaused Count (integer)required
    off_shift_countOff Shift Count (integer)required
    low_battery_countLow Battery Count (integer)required
    low_battery_window_minutesLow Battery Window Minutes (integer)required
    in_geofence_countIn Geofence Count (integer)required
    last_known_geofence_countLast Known Geofence Count (integer)required
    confirmed_current_geofence_countConfirmed Current Geofence Count (integer)required
    alerts_openAlerts Open (integer)required
    workflow_failures_1h object

    Null unless the caller is a workspace owner or manager.

    anyOf
    integer
    webhook_retries_1h object

    Null unless the caller is a workspace owner or manager.

    anyOf
    integer
    dashboard_metrics objectrequired
    time_rangeTime Range (string)required
    period_startstring<date-time>required
    period_endstring<date-time>required
    active_workflowsActive Workflows (integer)required
    events_totalEvents Total (integer)required
    action_delivery_success objectrequired
    rate object
    anyOf
    number
    successfulSuccessful (integer)required
    totalTotal (integer)required
    comparison objectrequired
    events_changeEvents Change (integer)required
    workflows_changeWorkflows Change (integer)required
    success_rate_change object
    anyOf
    number
    dlq_stats object

    Null unless the caller is a workspace owner or manager.

    anyOf
    total_entriesTotal Entries (integer)required
    not_requeuedNot Requeued (integer)required
    requeuedRequeued (integer)required
    top_failed_webhooks object[]required
  • Array [
    • webhook_idstring<uuid>required
    webhook_nameWebhook Name (string)required
    countCount (integer)required
  • ]
    • workspace_idstring<uuid>required
    workflow_stats object

    Null unless the caller is a workspace owner or manager.

    anyOf
    total_runs_24hTotal Runs 24H (integer)required
    successful_runs_24hSuccessful Runs 24H (integer)required
    failed_runs_24hFailed Runs 24H (integer)required
    success_rate object
    anyOf
    number
    sourceSource (string)required
    recent_events object[]required
  • Array [
    • idstring<uuid>required
    event_typeEvent Type (string)required
    device objectrequired
    idstring<uuid>required
    device_idDevice Id (string)required
    nameName (string)required
    driver_name object
    anyOf
    string
    typeType (string)required
    last_accuracy object
    anyOf
    number
    last_battery_level object
    anyOf
    integer
    last_battery_charging object
    anyOf
    boolean
    last_battery_time object
    anyOf
    string<date-time>
    geofence objectrequired
    idstring<uuid>required
    nameName (string)required
    description object
    anyOf
    string
    timestampstring<date-time>required
    location objectrequired
    latitudeLatitude (number)required
    longitudeLongitude (number)required
    accuracy object
    anyOf
    number
    speed object
    anyOf
    number
    workflows_triggeredstring[]required
    workflow_runs object[]required
  • Array [
    • execution_idExecution Id (string)required
    idstring<uuid>required
    workflow_idstring<uuid>required
  • ]
    • webhooks_triggeredstring[]required
    created_atstring<date-time>required
  • ]
    • OverviewOut
    {
      "badges": {
        "incidents_open": 0,
        "dlq_pending": 0,
        "integrations_degraded": 0
      },
      "incidents": [
        {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "signal_type": "string",
          "source_ids": [
            "string"
          ],
          "severity": "string",
          "opened_at": "2024-07-29T15:51:28.071Z",
          "acknowledged_at": "2024-07-29T15:51:28.071Z",
          "acknowledged_by": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "muted_until": "2024-07-29T15:51:28.071Z",
          "owner_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "resolved_at": "2024-07-29T15:51:28.071Z",
          "payload": {},
          "status": "string"
        }
      ],
      "dashboard_stats": {
        "active_device_count": 0,
        "live_count": 0,
        "reporting_count": 0,
        "offline_stale_count": 0,
        "expected_reporting_count": 0,
        "attention_count": 0,
        "parked_count": 0,
        "reporting_window_minutes": 0,
        "paused_count": 0,
        "off_shift_count": 0,
        "low_battery_count": 0,
        "low_battery_window_minutes": 0,
        "in_geofence_count": 0,
        "last_known_geofence_count": 0,
        "confirmed_current_geofence_count": 0,
        "alerts_open": 0,
        "workflow_failures_1h": 0,
        "webhook_retries_1h": 0
      },
      "dashboard_metrics": {
        "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
        }
      },
      "dlq_stats": {
        "total_entries": 0,
        "not_requeued": 0,
        "requeued": 0,
        "top_failed_webhooks": [
          {
            "webhook_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "webhook_name": "string",
            "count": 0
          }
        ],
        "workspace_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
      },
      "workflow_stats": {
        "total_runs_24h": 0,
        "successful_runs_24h": 0,
        "failed_runs_24h": 0,
        "success_rate": 0,
        "source": "string"
      },
      "recent_events": [
        {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "event_type": "string",
          "device": {
            "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "device_id": "string",
            "name": "string",
            "driver_name": "string",
            "type": "string",
            "last_accuracy": 0,
            "last_battery_level": 0,
            "last_battery_charging": true,
            "last_battery_time": "2024-07-29T15:51:28.071Z"
          },
          "geofence": {
            "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "name": "string",
            "description": "string"
          },
          "timestamp": "2024-07-29T15:51:28.071Z",
          "location": {
            "latitude": 0,
            "longitude": 0,
            "accuracy": 0,
            "speed": 0
          },
          "workflows_triggered": [
            "string"
          ],
          "workflow_runs": [
            {
              "execution_id": "string",
              "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
              "workflow_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
            }
          ],
          "webhooks_triggered": [
            "string"
          ],
          "created_at": "2024-07-29T15:51:28.071Z"
        }
      ]
    }