monitoring

One monitor's alert history

Changed on
get/v1/monitors/{monitorId}/alerts

Request

  • Base URL: https://api.offendersearch.app
  • URL: https://api.offendersearch.app/v1/monitors/{monitorId}/alerts
  • Auth: API key in header X-API-Key

Path parameters

monitorIdstring required

The monitor id (mon_…).

Query parameters

limitinteger

How many alerts to return, most recently observed first. Clamped to 1–200.

Response

The monitor's alerts.

Example response

{
  "alerts": [
    {
      "id": "hit_7fa176c8889c7569",
      "record": {
        "jurisdiction": "TX",
        "personRef": "prs_3c9e1f0a7b2d4e6f8a1b",
        "recordId": "rec_ab12cd34ef56gh78ij90"
      }
    }
  ]
}

Changes

  • 72fe5b5ea612Revision changes
    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

  • a2bbdbc2b735Revision changes
    • info

      the endpoint scheme security BearerAuth was removed from the API