COMPMON: Monitoring Snapshot
The COMPMON entity stores monitoring snapshots. A periodic monitoring snapshot for an asset, capturing SNMP and NMS metrics over a defined period for trend analysis and redundancy identification.
Default definition. This article describes the default
COMPMON definition shipped with DemandFlow. Administrators can add, remove, rename, or re-type fields, change which ones are required, and alter the layout from the Definitions screen in Settings. Your tenant's current schema may differ from what is shown here. To read the current definition at any time, GET the DEFINITION object whose id matches COMPMON.Entity properties
| Property | Value |
|---|---|
| Entity code | COMPMON |
| Display name | Monitoring Snapshot |
| Plural | Monitoring Snapshots |
| Level | 100010 |
Use cases
A periodic monitoring snapshot for an asset, capturing SNMP and NMS metrics over a defined period for trend analysis and redundancy identification.
Fields
Snapshot Details
| Field | Type | Required | Notes |
|---|---|---|---|
ref | text | Ref. Read-only | |
asset | reference → COMPINV | Yes | The equipment this snapshot relates to |
monitoringPeriod | text | Yes | Period label (e.g. March 2026) |
periodStart | datetime | Period Start | |
periodEnd | datetime | Period End | |
source | enum | Data Source. Valid ids: snmp (SNMP), solarwinds (SolarWinds), prtg (PRTG), librenms (LibreNMS), zabbix (Zabbix), nagios (Nagios), manual (Manual Entry), other (Other). | |
notes | text (multi-line) | Notes |
Network Traffic
| Field | Type | Required | Notes |
|---|---|---|---|
avgTrafficInMbps | number | Avg Traffic In (Mbps) | |
avgTrafficOutMbps | number | Avg Traffic Out (Mbps) | |
peakTrafficInMbps | number | Peak Traffic In (Mbps) | |
peakTrafficOutMbps | number | Peak Traffic Out (Mbps) | |
interfaceUtilPercent | number | Average utilisation of busiest interface | |
errorRate | number | Average interface error rate |
Port Utilisation
| Field | Type | Required | Notes |
|---|---|---|---|
activePortCount | number | Active Ports | |
totalPortCount | number | Total Ports |
Compute
| Field | Type | Required | Notes |
|---|---|---|---|
avgCpuPercent | number | Avg CPU (%) | |
peakCpuPercent | number | Peak CPU (%) | |
avgMemoryPercent | number | Avg Memory (%) | |
peakMemoryPercent | number | Peak Memory (%) | |
activeVmCount | number | Active VMs | |
totalVmCount | number | Total VMs |
Power & Uptime
| Field | Type | Required | Notes |
|---|---|---|---|
avgPowerDrawW | number | Avg Power Draw (W) | |
peakPowerDrawW | number | Peak Power Draw (W) | |
uptimeDays | number | From SNMP sysUpTime | |
availabilityPercent | number | Percentage of time the device was reachable |
Relationships
- Lookups:
assetpoints at aCOMPINVrecord.
Creating a Monitoring Snapshot via the API
POST /v1/objects
Authorization: Bearer <your-pat>
Content-Type: application/json
{
"entity": "COMPMON",
"level": 100010,
"comboKey": "SUB:<your-sub-id>|ENT:",
"asset": "",
"monitoringPeriod": "Example value"
} Listing Monitoring Snapshots
GET /v1/entities/COMPMON/SUB