Listing Monitors - Galtea Docs

Returns

Returns a list of Monitor objects.

monitors = galtea.monitors.list(
    product_ids=[product_id],
    statuses=["ACTIVE"],
)

product_ids

list[string]

Filter monitors by product IDs.

version_ids

list[string]

Filter monitors by version IDs.

names

list[string]

Filter by exact monitor names.

name

string

Filter by partial name match.

statuses

list[string | MonitorStatus]

Filter by monitor status. Possible values: ACTIVE, PAUSED, CAPPED, NO_CREDITS, FAILING.

metric_group_ids

list[string]

Filter by bound metric family IDs (metric.metric_group_id).

from_created_at

str | int

default:"None"

Filter monitors created at or after this timestamp. Accepts ISO 8601 string (e.g., '2024-01-01T00:00:00Z') or Unix timestamp in seconds.

to_created_at

str | int

default:"None"

Filter monitors created at or before this timestamp. Accepts ISO 8601 string (e.g., '2024-12-31T23:59:59Z') or Unix timestamp in seconds.

sort_by_created_at

string

Sort monitors by creation date. Valid values are "asc" and "desc".

offset

int

Number of monitors to skip before starting to collect results. Use for pagination.

limit

int

Maximum number of monitors to return in a single request.

string | list[string]

default:"None"

The ID or IDs of the monitor(s) to retrieve.