GET
/
metrics
curl --request GET \
  --url http://localhost/api/metrics
{
  "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": {}
                }
              }
            }
          ]
        }
      }
    }
  ],
  "meta": {
    "current_page": 123,
    "from": 123,
    "path": "<string>",
    "per_page": 123,
    "to": 123
  },
  "links": {
    "first": "<string>",
    "last": "<string>",
    "prev": "<string>",
    "next": "<string>"
  }
}

Query Parameters

sort
string

Available sorts are name, order, id. You can sort by multiple options by separating them with a comma. To sort in descending order, use - sign in front of the sort, for example: -name.

include
string

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

filter[name]
string

Filter by name.

filter[calc_type]
enum<integer>

Filter by calculation type.

Available options:
0,
1
per_page
integer
default:
15

How many items to show per page.

page
integer

Which page to show.

Response

200 - application/json
Paginated set of `Metric`
data
object[]
required
meta
object
required