GET /api/validation_incidents

Allows you to retrieve a list of validation incidents appropriately filtered.

Query parameters

  • start string Required

    an ISO8601 formatted date to query data from

  • filter string

    criteria to filter by

  • sort string

    criteria to sort by

  • end string Required

    an ISO8601 formatted date to query data until

Responses

  • 200 application/json

    OK

    Hide response attribute Show response attribute object
    • data array[object]

      Validation incidents

      Hide data attributes Show data attributes object
      • account_name string

        The name of the account that failed validation

      • booth_id string

        ID of the booth that failed validation

      • booth_name string

        The name of the booth that failed validation

      • booth_serial_number string

        The serial number of the booth that failed validation

      • facility_id string

        ID of the facility the booth belongs to

      • facility_name string

        The name of the facility the booth belongs to

      • first_seen_at string

        ISO8601 formatted timestamp when the validation failure was first detected

      • last_seen_at string

        ISO8601 formatted timestamp when the validation failure was most recently detected

      • logic object

        The logic defining the validation rule that failed, causing the validation incident

      • reason string

        Plain text explanation of the failure

      • resolved_at string

        ISO8601 formatted timestamp when the validation failure was resolved. Null if ongoing

      • tag_name string

        The name of the tag that failed validation

  • 401 application/json

    Unauthorized

    Hide response attribute Show response attribute object
    • error string

      Human readable version of the error status code

GET /api/validation_incidents
curl \
 --request GET 'http://localhost:4000/api/validation_incidents?start=string&end=string' \
 --header "Authorization: $API_KEY"
Response examples (200)
{
  "data": [
    {
      "logic": {
        "op": "between",
        "max": 10,
        "min": 0
      },
      "reason": "value 11 is above maximum 10",
      "booth_id": "f7739e5f-b86e-4f42-bfcc-b07e3e6f917c",
      "tag_name": "iHMI_BoothPressure",
      "booth_name": "Booth 1",
      "facility_id": "d83a8743-4d38-403c-bc72-c4ec2ce036a7",
      "resolved_at": "2026-02-04 19:24:20Z",
      "last_seen_at": "2026-02-04 19:23:15Z",
      "facility_name": "Repair Shop Carson City",
      "first_seen_at": "2026-02-02 13:52:32Z"
    },
    {
      "logic": {
        "op": "non_zero",
        "min_count": 60,
        "in_use_only": true,
        "duration_minutes": 1440
      },
      "reason": "value is always zero",
      "booth_id": "7fb56dae-6a60-49c7-8a3c-afc18690ccad",
      "tag_name": "xHMI_KW_Est",
      "booth_name": "Booth 2",
      "facility_id": "41dd44be-e322-4a37-8f61-de1143216056",
      "last_seen_at": "2026-02-05 12:00:00",
      "facility_name": "Unlucky Facility",
      "first_seen_at": "2025-09-30 11:34:34"
    }
  ]
}
Response examples (401)
{
  "error": "Error Reason"
}