Monitors

List monitor summaries

List AI-generated summaries produced for a monitor as matching content is processed.

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

Request

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

Path parameters

uuidstring uuid required

UUID of the monitor whose summaries to retrieve.

Query parameters

fromstring date-time

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

tostring date-time

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

sortBystring required

Required field used to sort summaries. 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 summaries across all pages.

Example response

{
  "total": 1,
  "data": [
    {
      "text": "Several major AI labs announced new model releases this week, with coverage focused on capabilities and enterprise availability.",
      "createdAt": "2025-08-12T12:00:00.000Z",
      "updatedAt": "2025-08-12T12:00:00.000Z"
    }
  ]
}

Changes

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