Schema reference for the objects the v2 API returns.
Alert
Describes an alert type available for querying.
| Attribute | Type | Nullable | Description |
|---|
id | string | NO | Opaque identifier for this alert type. Pass this value in the alertIds query parameter of GET /alerts/data to retrieve alert instances. |
name | string | NO | Human-readable display name of the alert type. |
description | string | NO | Description of the condition this alert type detects. |
supportedServerTypes | string array | NO | Server types this alert type applies to (e.g. SqlServer, Machine). See Entity types. |
AlertData
An alert instance that was active within the requested time range.
| Attribute | Type | Nullable | Description |
|---|
alertId | string | NO | ID of the alert type this instance belongs to (matches AlertDto.Id from GET /alerts). |
alertName | string | NO | Display name of the alert type. Empty string when the alert has no name. |
status | AlertStatus | NO | Current lifecycle state of the alert instance at the time of the response, regardless of the queried time range. An alert that was active during a past range may appear as Ended if it has since resolved. Does not reflect whether the alert has been cleared. |
cleared | boolean | NO | Whether the alert has been manually cleared. An alert can be cleared regardless of its status. |
severity | AlertSeverity | NO | Worst severity reached by the alert instance during its lifetime. |
raisedTime | string | NO | UTC timestamp when the alert was first raised. |
endTime | string | YES | UTC timestamp when the alert ended. null when the alert has not yet ended (i.e. status is Active or Event). |
entityId | string | NO | Opaque entity ID for the entity the alert was raised against. Pass this value as an entityId in GET /monitored-servers to retrieve the server's details. |
entityName | string | NO | Display name of the entity the alert was raised against. |
entityType | string | NO | Type of the entity the alert was raised against. See Entity types. |
parentEntity | ParentEntity | YES | The parent entity in the server hierarchy (e.g. the cluster for a SQL Server instance). null for top-level entities with no parent. |
JSendError
| Attribute | Type | Nullable | Description |
|---|
status | object | NO | |
message | string | NO | |
JSendFailure
| Attribute | Type | Nullable | Description |
|---|
status | object | NO | |
data | object | NO | |
JSendMessageOnlyError
| Attribute | Type | Nullable | Description |
|---|
status | object | NO | |
message | string | NO | |
Metric
Describes a metric available for querying.
| Attribute | Type | Nullable | Description |
|---|
id | string | NO | Opaque identifier for this metric. Pass this value as metricIds in GET /metrics/data to retrieve sampled data. |
name | string | NO | Human-readable display name of the metric. |
supportedServerTypes | string array | NO | Server types this metric applies to (e.g. Machine, SqlServer). See Entity types. |
MetricDataPoint
A single sampled value at a point in time.
| Attribute | Type | Nullable | Description |
|---|
timestamp | string | NO | UTC timestamp of the sample. |
value | number | NO | The measured value. Units are specified by MetricSeriesDto.DataUnit. |
MetricSeries
A time series of data points for one metric and one monitored entity.
| Attribute | Type | Nullable | Description |
|---|
metricId | string | NO | ID of the metric this series belongs to (matches MetricV2Dto.Id). |
metricName | string | NO | Display name of the metric. |
entityType | string | NO | Type of the entity this series belongs to. See Entity types. |
entityId | string | NO | Opaque entity ID for the entity directly attached to metric. Pass this value or any entity id in the server hierarchy as entityIds in GET /metrics/data to restrict future queries to this entity. |
entityName | string | NO | Display name of the entity. |
dataUnit | string | NO | Unit of measurement for the data values (e.g. Milliseconds, Percent). Dimensionless metrics use Number. |
dataPoints | MetricDataPoint array | NO | Ordered list of sampled values over the requested time range. Empty when no data exists for the range. |
parentEntity | ParentEntity | YES | The parent entity in the server hierarchy (e.g. the host machine for a SQL Server instance). null for top-level entities. |
MonitoredServer
Represents a monitored server (server, cluster, or cloud instance).
| Attribute | Type | Nullable | Description |
|---|
entityId | string | NO | Opaque, URL-safe identifier for this server. Pass this value to GET /monitored-servers/{entityId} to retrieve the server directly, or as an entityIds filter on other v2 endpoints (e.g. GET /metrics/data). |
name | string | NO | The display name of the server. |
alias | string | YES | Optional user-defined alias for the server. null when no alias has been set. |
entityType | string | NO | The type of server (e.g. SqlServer, LinuxMachine). See Entity types. |
group | string | NO | The top-level group this server belongs to. |
status | MonitoredEntityStatusCategory | NO | The current monitoring status of the server. |
tags | string array | NO | User-defined tags attached to this server. |
parentEntityId | string | YES | ID of the parent server, if this server is nested (e.g. a SQL Server under a host machine). null for top-level servers. |
ParentEntity
Identifies an entity in the server hierarchy, together with an optional chain of parent entities up to the root.
| Attribute | Type | Nullable | Description |
|---|
entityId | string | NO | Opaque entity ID. |
entityName | string | NO | Display name of the entity. |
entityType | string | NO | Type of the entity. See Entity types. |
parentEntity | ParentEntity | YES | Further ancestor in the hierarchy, if any. null at the top of the hierarchy; the chain terminates when this field is null. |
ProblemDetails
| Attribute | Type | Nullable | Description |
|---|
type | string | YES | |
title | string | YES | |
status | integer | YES | |
detail | string | YES | |
instance | string | YES | |
AlertSeverity
The severity level of an alert instance.
AlertStatus
The lifecycle state of an alert instance.
MonitoredEntityStatusCategory
| Value |
|---|
Monitoring |
Suspended |
NotMonitoring |
CredentialDecryptionFailed |
Entity types
The values the entity type fields (Alert.supportedServerTypes, AlertData.entityType, Metric.supportedServerTypes, MetricSeries.entityType, MonitoredServer.entityType, ParentEntity.entityType) and the supportedServerTypes / entityType query parameters can take.
| Value | Description |
|---|
AmazonRdsHost | Amazon RDS host instance for non SQL Server instances |
AmazonRdsSqlServer | Amazon RDS SQL Server instance |
AzureFlexHost | A host running an Azure Database Flexible Server deployment |
AzureManagedInstance | Azure SQL Managed Instance |
AzureSqlDatabase | An individual Azure SQL Database, hosted under an Azure SQL logical server |
AzureSqlServer | Virtual SQL Server in Azure used to group Azure SQL Databases |
Cluster | Windows cluster instance, this will be the machine for a standalone server. |
GoogleCloudHost | A host for a Google Cloud SQL instance |
LinuxMachine | Linux machine instance |
Machine | Windows machine which hosts a SQL Server instance |
MongoDbInstance | A MongoDB instance |
MySqlInstance | A MySQL instance |
OracleDataGuard | An Oracle Data Guard configuration |
OracleInstance | An Oracle Database instance |
PostgresServer | Postgres server instance |
SqlServer | SQL Server instance on a Windows machine |
SqlServerInstance | SQL Server instance on a Linux machine and Google Cloud SQL instance |
