VEverdun
analytics

Get Analytics Summary

get/analytics/summary

Request

  • Base URL
    https://api.verdun.ai (the document declares no server; this is the origin it was published from)
  • URL
    https://api.verdun.ai/analytics/summary
  • Auth
    HTTP bearer

Query parameters

startstring date-time nullable

Report start; window must be positive and at most 366 days.

endstring date-time nullable

Report end; exclusive for hourly alarm volume.

parent_idstring[] nullable
site_idstring[] nullable
camera_idstring nullable
operator_idstring[] nullable
include_agentboolean

Include agent-mode evaluations (actor='agent') in every figure. Default false: the dashboard measures operator decisions only, and metrics.agent_evaluations reports how many agent rows were left out.

tzstring nullable

IANA time zone for the hour-of-day chart (e.g. America/Los_Angeles). Defaults to UTC.

slow_threshold_secondsinteger
stale_after_secondsinteger nullable

When set, dispositions of alarms that were already older than this many seconds (event-created -> disposition) when cleared are excluded from every metric in the response. Omit to include everything (the default).

Response

Successful Response

range_startstring date-time required

Start of the reported range (UTC).

range_endstring date-time required

End of the reported range (UTC).

include_agentboolean

Whether agent-mode evaluations are included in this response's figures (default false: operator decisions only).

slow_totalinteger required

Exact count of over-threshold dispositions in the window; slow is capped at 200 for response size, so this is the count to display (e.g. an 'Over target' metric card) — it stays exact even when slow is truncated.

Example response

{
  "metrics": {
    "resolved": 31,
    "auto_archived": 14,
    "avg_response_seconds": 42.5,
    "median_response_seconds": 25,
    "p90_response_seconds": 211,
    "agent_evaluations": 9268
  },
  "breakdown": [
    {
      "disposition": "False alarm - no human activity",
      "count": 22
    }
  ],
  "operators": [
    {
      "first_name": "Sonny",
      "last_name": "Tai",
      "reviewed": 18,
      "avg_response_seconds": 38,
      "median_response_seconds": 24,
      "p90_response_seconds": 180,
      "false_alarm_pct": 71,
      "escalation_pct": 22
    }
  ],
  "recent": [
    {
      "response_seconds": 48,
      "disposition": "False alarm - no human activity",
      "camera": {
        "label": "Loading dock",
        "camera_id": "cam01"
      }
    }
  ],
  "slow": [
    {
      "response_seconds": 48,
      "disposition": "False alarm - no human activity",
      "camera": {
        "label": "Loading dock",
        "camera_id": "cam01"
      }
    }
  ],
  "hourly": {
    "timezone": "America/Los_Angeles"
  },
  "slow_total": 3
}

Changes

No recorded changes to this operation across all 2 revisions of this API.