Monitors

List monitor newsletters

List newsletters generated for a monitor. Newsletters bundle a monitor's recent events into a human-readable digest and are produced on the monitor's configured schedule.

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

Request

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

Path parameters

uuidstring uuid required

UUID of the monitor whose newsletters to retrieve.

Query parameters

titlestring

Filter by newsletter title using a case-insensitive partial match.

fromstring date-time

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

tostring date-time

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

sortBystring required

Required field used to sort newsletters. Accepts createdAt or updatedAt.

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 newsletters across all pages.

Example response

{
  "total": 1,
  "data": [
    {
      "uuid": "c3d4e5f6-a7b8-9012-cdef-123456789012",
      "createdAt": "2025-08-12T14:00:00.000Z",
      "updatedAt": "2025-08-12T14:00:00.000Z",
      "title": "Weekly AI Launch Digest",
      "content": "This week saw several notable AI product announcements across the industry.",
      "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
        }
      },
      "stories": {}
    }
  ]
}

Changes

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