Skip to main content
GET
ListMonitors

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

integrationIds
string[]
monitoredAssetPaths
string[]
monitorIds
string[]
source
string[]
deprecated
configIds
string[]
deprecated
configsFilter.ids
string[]
sources
enum<string>[]
Available options:
SOURCE_APP,
SOURCE_API
includeDeleted
boolean

Include deleted monitors in the listing. Off by default, so an ordinary listing keeps describing only what is live.

Turn it on to resolve a monitor_ids entry that may name a deleted monitor. The id this endpoint returns is the only reference a caller holds after creating or listing a monitor, and the monitored asset needed to address the same monitor as an entity is on the stored row and nowhere else, so a listing that excluded it left the id unresolvable.

One entry per monitor either way: a monitor keeps a row per version, and the listing reports the latest one. deleted_at on each returned monitor is what tells a deleted monitor from a live one.

pagination.cursor
string

Opaque cursor token for the next page of results. If not provided, returns the first page. This is an encoded token that should be passed as-is from the previous PageInfo.last_id.

pagination.pageSize
integer<int32>

Maximum number of items to return in a single page. If not provided, defaults vary per API.

Required range: x >= 0

Response

200 - application/json

Success

pageInfo
PageInfo · object
required

Paging information.

monitors
MonitorDefinition · object[]

filter_not_supported_for_table_stats // filter is not supported for table stats monitors segmentation_not_supported_for_field_stats_and_table_stats // Segmentation is not supported for field stats and table stats monitors sql_source_not_supported_for_table_stats // sql_source is not supported for table stats monitors time_partitioning_forbidden_for_table_stats // time_partitioning must not be set when table_stats is set