Endpoint
/api/v2/metric/tenants/{tenantId}/metrics/{metric}/metricType
Path Parameters
tenantIdstring
metricstring
Responses
OK
componentstring
consolFuncstring
dataobject
descriptionstring
Summary of the metric type.
displayByComponentboolean
displayNamestring
Metric display name.
displayOrderinteger
displayUnitstring
(Optional) Unit name displayed in the graph.
factorinteger
groupNamestring
(Optional) Metric group name.
lastValsobject
maxValsobject
metricstring
Metric type name.
metricTypestring
Metric type.
minValsobject
resourceinteger
resourceTypestring
(Optional) Resource type.
timeSeriesTypestring
topMetricboolean
unitstring
Metric type unit.
unitLabelstring
(Optional) Label of the y-axis in the graph widget).
{
"consolFunc": "AVERAGE",
"description": "Sample metric test please ignore",
"displayByComponent": false,
"displayName": "Metric test",
"displayOrder": 100,
"displayUnit": " Packets per minute (packet/min)",
"factor": 1,
"groupName": "system.device.test.*",
"metricName": "system.metric.file.send",
"resourceType": "Device",
"topMetric": false,
"type": "Counter",
"unit": "packet/min",
"unitLabel": " Packets per minute (packet/min)"
}
Endpoint
/api/v2/metric/tenants/{tenantId}/metrics/{metric}/metricType
Path Parameters
tenantIdstring
metricstring
componentstring
consolFuncstring
dataobject
descriptionstring
Summary of the metric type.
displayByComponentboolean
displayNamestring
Metric display name.
displayOrderinteger
displayUnitstring
(Optional) Unit name displayed in the graph.
factorinteger
groupNamestring
(Optional) Metric group name.
lastValsobject
maxValsobject
metricstring
Metric type name.
metricTypestring
Metric type.
minValsobject
resourceinteger
resourceTypestring
(Optional) Resource type.
timeSeriesTypestring
topMetricboolean
unitstring
Metric type unit.
unitLabelstring
(Optional) Label of the y-axis in the graph widget).
{
"description": "Cpu Statistics",
"displayName": "CPUSTATS",
"displayUnit": "%",
"groupName": "system.cpustats.*",
"metricName": "system.cpu.stats.kernel",
"type": "Gauge",
"unit": "%",
"unitLabel": "Percentage"
}
Responses
OK