Metrics
Get Metric
API Documentation
Components
Component Groups
Incident Updates
Incident Templates
MetricPoint
Metrics
Get Metric
GET
/
metrics
/
{metric}
curl --request GET \
--url http://localhost/api/metrics/{metric}
{
"data": {
"id": "<string>",
"type": "metrics",
"attributes": {
"id": "<string>",
"name": "<string>",
"suffix": "<string>",
"description": "<string>",
"default_value": "<string>",
"calc_type": "<string>",
"display_chart": "<string>",
"places": "<string>",
"default_view": "<string>",
"threshold": "<string>",
"order": "<string>",
"visible": "<string>",
"created": {
"human": "<string>",
"string": "<string>"
},
"updated": {
"human": "<string>",
"string": "<string>"
}
},
"relationships": {
"points": {
"data": [
{
"id": "<string>",
"type": "metricPoints",
"attributes": {
"id": "<string>",
"metric_id": "<string>",
"calculated_value": "<string>",
"value": "<string>",
"counter": "<string>",
"created": {
"human": "<string>",
"string": "<string>"
},
"updated": {
"human": "<string>",
"string": "<string>"
}
},
"relationships": {
"metric": {
"data": {}
}
}
}
]
}
}
}
}
Path Parameters
The metric ID
Query Parameters
Available includes are points
, pointsCount
, pointsExists
. You can include multiple options by separating them with a comma.
Response
200
application/json
`Metric`
Available options:
metrics
curl --request GET \
--url http://localhost/api/metrics/{metric}
{
"data": {
"id": "<string>",
"type": "metrics",
"attributes": {
"id": "<string>",
"name": "<string>",
"suffix": "<string>",
"description": "<string>",
"default_value": "<string>",
"calc_type": "<string>",
"display_chart": "<string>",
"places": "<string>",
"default_view": "<string>",
"threshold": "<string>",
"order": "<string>",
"visible": "<string>",
"created": {
"human": "<string>",
"string": "<string>"
},
"updated": {
"human": "<string>",
"string": "<string>"
}
},
"relationships": {
"points": {
"data": [
{
"id": "<string>",
"type": "metricPoints",
"attributes": {
"id": "<string>",
"metric_id": "<string>",
"calculated_value": "<string>",
"value": "<string>",
"counter": "<string>",
"created": {
"human": "<string>",
"string": "<string>"
},
"updated": {
"human": "<string>",
"string": "<string>"
}
},
"relationships": {
"metric": {
"data": {}
}
}
}
]
}
}
}
}