Endpoint Data Mapping
Published 04 April 2024
The API endpoints' data have relationships that can be leveraged to improve how you perceive the data. The following are some useful data mapping.
Joining Endpoint Data
You can perform joins on specific properties of the data obtained from different endpoints. The table below outlines the properties and endpoints on which you can perform joins.
Endpoint | Property | Mapped Endpoint | Mapped Property |
---|---|---|---|
/api/v1/alerts/types | id name | /api/v1/alerts | alertType.id alertType.name |
/api/v1/metrics/types | id name | /api/v1/metrics | metricType.id metricType.name |
/api/v1/monitored-entities/types | entityType | /api/v1/monitored-entities | type |
/api/v1/monitored-entities | id name | monitoredEntity.id monitoredEntity.name |
Monitored entity types
Entity Type | Description |
---|---|
Cluster | Windows cluster instance (This will be a machine in the case of a standalone machine) |
Machine | Windows machine which hosts a SQL Server instance |
LinuxMachine | Linux machine instance |
AmazonRdsHost | Amazon RDS host instance |
SqlServer | SQL Server instance on a Windows machine |
SqlServerInstance | SQL Server instance on a Linux machine |
PostgresInstance | Postgres server instance |
AzureManagedInstance | Azure SQL Managed Instance |
AzureSqlServer | Virtual SQL Server in Azure used to group Azure SQL Databases |
AmazonRdsSqlServer | Amazon RDS SQL Server instance |
Metric type to Monitored entity mapping
The following table gives you a list of metric IDs supported by the relevant entity type
Entity Type | Metric Type Id's |
---|---|
Cluster - Windows cluster instance (This will be a machine in the case of a standalone machine) |
|
Machine - Windows machine which hosts a SQL Server instance |
|
LinuxMachine - Linux machine instance |
|
AmazonRdsHost - Amazon RDS host instance |
|
SqlServer - SQL Server instance on a Windows machine |
|
SqlServerInstance - SQL Server instance on a Linux machine |
|
PostgresInstance - Postgres server instance |
|
AzureManagedInstance - Azure SQL Managed Instance |
|
AzureSqlServer - Virtual SQL Server in Azure used to group Azure SQL Databases |
|
AmazonRdsSqlServer - Amazon RDS SQL Server instance |
|