Skip to main content
GET
Get a monitor

Authorizations

Authorization
string
header
required

Most Arize AI endpoints require authentication. For those endpoints that require authentication, include your API key in the request header using the format

Path Parameters

monitor_id
string
required

The unique monitor identifier (base64) A universally unique identifier (base64-encoded opaque string).

Example:

"RW50aXR5OjEyMzQ1"

Response

Returns a single monitor object

A monitor. The type field discriminates which variant (and therefore which type-specific fields) applies.

id
string
required

Unique identifier for the monitor (base64 global ID).

name
string
required

Human-readable name of the monitor.

type
enum<string>
required

Required on create. Immutable after creation.

Available options:
DATA_QUALITY
project_id
string
required

The project that the monitor belongs to (base64 global ID).

uri
string
required
read-only

The UI deep link to the monitor.

status
enum<string>
required

Current evaluation state. Read-only.

Available options:
TRIGGERED,
CLEARED,
NO_DATA
threshold
object
required

The monitor's threshold. The type field discriminates whether the threshold is manual or dynamic, and single or a bounded range.

notifications_enabled
boolean
default:true
required

Whether notifications fire on a triggered transition.

manual_evaluation_enabled
boolean
default:false
required

Whether the monitor is evaluated manually rather than on the automatic cadence.

created_by_user_id
string
required

The user who created the monitor (base64 global ID).

created_at
string<date-time>
required
read-only

When the monitor was created.

updated_at
string<date-time>
required
read-only

When the monitor was last updated.

metric
enum<string>
required

The data quality metric computed over the selected dimension.

Available options:
COUNT,
PERCENT_EMPTY,
CARDINALITY,
NEW_VALUES,
MISSING_VALUES,
AVG,
SUM,
STANDARD_DEVIATION,
P50,
P95,
P99,
P99_9,
AVERAGE_STRING_LIST_LENGTH
dimension
object
required
model_versions
string[]
required

The model versions the metric is scoped to. An empty array means all model versions.

filters
object[]

Data filters applied to the monitor's metric. Omitted when the metric is computed over all data.

notification_configs
object[]

Notification channels (email / integration / webhook) notified on a triggered transition. Omitted when no channels are configured.

downtime
object
scheduled_runtime
object

Returned when schedule configuration exists.

evaluation_window_length_seconds
integer

The length of the evaluation window in seconds. Omitted when unset.

delay_seconds
integer

The delay applied before evaluating a window, in seconds. Omitted when unset.

evaluated_at
string<date-time>
read-only

The last time the metric was computed. Omitted if it has never been evaluated.

latest_computed_value
number
read-only

The most recently computed metric value. Omitted if it has never been evaluated.

notes
string

Free-form notes attached to the monitor. Omitted when unset.

baseline_config
object

The comparison dataset configuration used by drift and comparison-based data quality monitors. The type field determines whether the comparison dataset uses the model's primary baseline or a custom fixed or moving window.