Monitors

List monitors

List AI monitors for the organization associated with the API key. Excludes archived monitors by default. Use the status parameter to filter.

get/v1/api/monitors

Request

  • Base URL: https://api.perigon.io
  • URL: https://api.perigon.io/v1/api/monitors
  • Auth: HTTP bearer

Query parameters

uuidstring[]

Filter by one or more monitor UUIDs. Multiple values are combined with OR.

namestring

Filter by monitor name using a case-insensitive partial match.

statusstring[]

Filter by status: DRAFT, ACTIVE, STOPPED, or ARCHIVED. When omitted, archived monitors are excluded.

classificationTypestring[]

Filter by classification type: EVENT, MENTIONS, or TOPIC. Multiple values are combined with OR.

sortBystring required

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

Example response

{
  "total": 2,
  "data": [
    {
      "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "name": "AI Product Launches",
      "createdAt": "2025-08-01T14:22:10.123Z",
      "updatedAt": "2025-08-12T09:15:44.567Z",
      "status": "ACTIVE",
      "classificationType": "EVENT",
      "monitoringObjective": "Track major AI product launches and model releases.",
      "prompt": null,
      "dataSchema": {
        "version": "V1",
        "allowExtra": false,
        "schema": {
          "eventType": {
            "type": "ENUM",
            "description": "Type of AI product announcement",
            "nullable": false,
            "required": true,
            "values": [
              "PRODUCT_LAUNCH",
              "MODEL_RELEASE"
            ]
          },
          "productName": {
            "type": "STRING",
            "description": "Name of the launched product or model",
            "nullable": true,
            "required": true
          }
        }
      },
      "newsletterConfig": null,
      "entityGroups": [],
      "query": {
        "q": "AI",
        "sourceGroup": [
          "top100"
        ]
      },
      "schedulePolicy": {
        "intervals": [
          {
            "hour": 9,
            "minute": 0
          }
        ],
        "timezoneId": "UTC"
      },
      "watchlistId": null,
      "contactPointIds": []
    }
  ]
}

Changes

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