Skip to main content
GET
/
metrics
/
{metric}
Get Metric
curl --request GET \
  --url http://localhost/api/metrics/{metric} \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "id": "<string>",
    "type": "metrics",
    "attributes": {
      "id": 123,
      "name": "<string>",
      "suffix": "<string>",
      "description": "<string>",
      "default_value": "<string>",
      "calc_type": 0,
      "display_chart": true,
      "places": 123,
      "default_view": 0,
      "threshold": 123,
      "order": 123,
      "visible": 0,
      "created": {
        "human": "<string>",
        "string": "<string>"
      },
      "updated": {
        "human": "<string>",
        "string": "<string>"
      }
    },
    "relationships": {
      "points": {
        "data": [
          {
            "type": "metricPoints",
            "id": "<string>"
          }
        ]
      }
    }
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
metric
integer
required

The metric ID

Query Parameters

​
include
string

Available includes are points, pointsCount, pointsExists. You can include multiple options by separating them with a comma.

Response

Metric

​
data
Metric · object
required