Monitors

List monitor events

List structured events emitted by a monitor. Events represent individual matches detected by the monitor (e.g. a news article matching the monitor's criteria) and are produced asynchronously as new content is ingested.

get/v1/api/monitors/{uuid}/events

Request

  • Base URL: https://api.perigon.io
  • URL: https://api.perigon.io/v1/api/monitors/{uuid}/events
  • Auth: HTTP bearer

Path parameters

uuidstring uuid required

UUID of the monitor whose events to retrieve.

Query parameters

eventTypestring

Filter for events with this exact event type.

fromstring date-time

Filter for events created on or after this date. Accepts ISO 8601 or yyyy-mm-dd format.

tostring date-time

Filter for events created on or before this date. Accepts ISO 8601 or yyyy-mm-dd format.

sortBystring required

Required field used to sort events. Accepts createdAt, updatedAt, or eventDate.

pageinteger

Zero-based page number to retrieve. Defaults to 0.

sizeinteger

Number of results per page. Must be between 1 and 100; defaults to 10.

sortOrder'asc' | 'desc' required

Required direction used to sort results. Accepts asc or desc.

nulls'first' | 'last'

Placement of null values in sorted results. Accepts first or last.

Response

200 - Success

totalinteger required

Total number of matching events across all pages.

Example response

{
  "total": 1,
  "data": [
    {
      "uuid": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "createdAt": "2025-08-12T10:05:22.100Z",
      "updatedAt": "2025-08-12T10:05:22.100Z",
      "eventDate": "2025-08-12T08:30:00Z",
      "eventType": "product_launch",
      "data": {
        "productName": "GPT-5",
        "company": "OpenAI"
      },
      "relatedArticleIds": [
        "97dce2f1bdcd441c99360e58d38e811d"
      ],
      "articles": {
        "97dce2f1bdcd441c99360e58d38e811d": {
          "title": "OpenAI unveils next-generation language model",
          "url": "https://www.reuters.com/technology/openai-unveils-next-generation-model-2025-08-12/",
          "domain": "reuters.com",
          "pubDate": "2025-08-12T08:15:00+00:00",
          "sourceFavicon": "https://www.reuters.com/favicon.ico",
          "highlights": null
        }
      },
      "entities": [
        {
          "name": "OpenAI",
          "type": "COMPANY"
        }
      ],
      "summary": "OpenAI announced a new flagship language model."
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.