StatusGator Octri Preview
GET/boards/{board_id}/monitors/{monitor_id}/components

List monitor components

Retrieve active components for a specific monitor with status information.

Behavior:

  • StatusPageService monitors with no component filters: Returns all components from the service (monitoring all components)
  • StatusPageService monitors with component filters: Returns only the filtered/subscribed components
  • Non-StatusPageService monitors (WebsiteMonitor, PingMonitor, etc.): Returns empty array

Components include current status.

5 parameters
board_idstringrequired
Public ID of the board
monitor_idstringrequired
Public ID of the monitor
pageintegeroptional
Page number for pagination (default: 1)
per_pageintegeroptional
Number of items per page (default: 25, max: 100)
statusstringoptional
Filter components by status. Use "affected" to get all non-up components, or specify status values (comma-separated for multiple: "down,warn")

4 status codes
200monitor components found
dataarray<object>optional
paginationobjectoptional
successbooleanoptional
400invalid status value
401unauthorized
404monitor not found

Error handling

A 400 is returned: invalid status value. A 401 is returned: unauthorized. A 404 is returned: monitor not found.