Represents a single monitoring alert. This is currently used in the modelMonitors.searchModelMonitoringAlerts api, thus the alert wrapped in this message belongs to the resource asked in the request.
Fields
statsName
string
The stats name.
objectiveType
string
One of the supported monitoring objectives: raw-feature-driftprediction-output-driftfeature-attribution
Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-06-27 UTC."],[],[],null,["# Method: modelMonitors.searchModelMonitoringAlerts\n\n**Full name**: projects.locations.modelMonitors.searchModelMonitoringAlerts\n\nReturns the Model Monitoring alerts. \n\n### Endpoint\n\npost `https:``/``/{service-endpoint}``/v1beta1``/{modelMonitor}:searchModelMonitoringAlerts` \nWhere `{service-endpoint}` is one of the [supported service endpoints](/vertex-ai/docs/reference/rest#rest_endpoints).\n\n### Path parameters\n\n`modelMonitor` `string` \nRequired. ModelMonitor resource name. Format: `projects/{project}/locations/{location}/modelMonitors/{modelMonitor}`\n\n### Request body\n\nThe request body contains data with the following structure:\nFields `modelMonitoringJob` `string` \nIf non-empty, returns the alerts of this model monitoring job.\n`alertTimeInterval` `object (`[Interval](/vertex-ai/docs/reference/rest/Shared.Types/Interval)`)` \nIf non-empty, returns the alerts in this time interval.\n`statsName` `string` \nIf non-empty, returns the alerts of this statsName.\n`objectiveType` `string` \nIf non-empty, returns the alerts of this objective type. Supported monitoring objectives: `raw-feature-drift` `prediction-output-drift` `feature-attribution`\n`pageSize` `integer` \nThe standard list page size.\n`pageToken` `string` \nA page token received from a previous [ModelMonitoringService.SearchModelMonitoringAlerts](/vertex-ai/docs/reference/rest/v1beta1/projects.locations.modelMonitors/searchModelMonitoringAlerts#google.cloud.aiplatform.v1beta1.ModelMonitoringService.SearchModelMonitoringAlerts) call. \n\n### Response body\n\nResponse message for [ModelMonitoringService.SearchModelMonitoringAlerts](/vertex-ai/docs/reference/rest/v1beta1/projects.locations.modelMonitors/searchModelMonitoringAlerts#google.cloud.aiplatform.v1beta1.ModelMonitoringService.SearchModelMonitoringAlerts).\n\nIf successful, the response body contains data with the following structure:\nFields `modelMonitoringAlerts[]` `object (`[ModelMonitoringAlert](/vertex-ai/docs/reference/rest/v1beta1/projects.locations.modelMonitors/searchModelMonitoringAlerts#ModelMonitoringAlert)`)` \nAlerts retrieved for the requested objectives. Sorted by alert time descendingly.\n`totalNumberAlerts` `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` \nThe total number of alerts retrieved by the requested objectives.\n`nextPageToken` `string` \nThe page token that can be used by the next [ModelMonitoringService.SearchModelMonitoringAlerts](/vertex-ai/docs/reference/rest/v1beta1/projects.locations.modelMonitors/searchModelMonitoringAlerts#google.cloud.aiplatform.v1beta1.ModelMonitoringService.SearchModelMonitoringAlerts) call. \n\nModelMonitoringAlert\n--------------------\n\nRepresents a single monitoring alert. This is currently used in the modelMonitors.searchModelMonitoringAlerts api, thus the alert wrapped in this message belongs to the resource asked in the request.\nFields `statsName` `string` \nThe stats name.\n`objectiveType` `string` \nOne of the supported monitoring objectives: `raw-feature-drift` `prediction-output-drift` `feature-attribution`\n`alertTime` `string (`[Timestamp](https://protobuf.dev/reference/protobuf/google.protobuf/#timestamp)` format)` \nAlert creation time.\n\nUses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than \"Z\" are also accepted. Examples: `\"2014-10-02T15:01:23Z\"`, `\"2014-10-02T15:01:23.045123456Z\"` or `\"2014-10-02T15:01:23+05:30\"`.\n`anomaly` `object (`[ModelMonitoringAnomaly](/vertex-ai/docs/reference/rest/v1beta1/projects.locations.modelMonitors/searchModelMonitoringAlerts#ModelMonitoringAnomaly)`)` \nAnomaly details. \n\nModelMonitoringAnomaly\n----------------------\n\nRepresents a single model monitoring anomaly.\nFields `modelMonitoringJob` `string` \nModel monitoring job resource name.\n`algorithm` `string` \nalgorithm used to calculated the metrics, eg: jensen_shannon_divergence, l_infinity. \n`anomaly` `Union type` \n`anomaly` can be only one of the following:\n`tabularAnomaly` `object (`[TabularAnomaly](/vertex-ai/docs/reference/rest/v1beta1/projects.locations.modelMonitors/searchModelMonitoringAlerts#TabularAnomaly)`)` \nTabular anomaly. \n\nTabularAnomaly\n--------------\n\nTabular anomaly details.\nFields `anomalyUri` `string` \nAdditional anomaly information. e.g. Google Cloud Storage uri.\n`summary` `string` \nOverview of this anomaly.\n`anomaly` `value (`[Value](https://protobuf.dev/reference/protobuf/google.protobuf/#value)` format)` \nAnomaly body.\n`triggerTime` `string (`[Timestamp](https://protobuf.dev/reference/protobuf/google.protobuf/#timestamp)` format)` \nThe time the anomaly was triggered.\n\nUses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than \"Z\" are also accepted. Examples: `\"2014-10-02T15:01:23Z\"`, `\"2014-10-02T15:01:23.045123456Z\"` or `\"2014-10-02T15:01:23+05:30\"`.\n`condition` `object (`[ModelMonitoringAlertCondition](/vertex-ai/docs/reference/rest/v1beta1/TabularObjective#ModelMonitoringAlertCondition)`)` \nThe alert condition associated with this anomaly."]]
