List Metric

List metrics. The metrics are in no particular order.

GET /v1/metrics

List Metric

cURL

curl --request GET \
  --url https://metrics.eu.confidence.dev/v1/metrics \
  --header 'Authorization: Bearer <token>'

200

{
  "metrics": [
    {
      "displayName": "<string>",
      "entity": "<string>",
      "factTable": "<string>",
      "typeSpec": {},
      "createTime": {},
      "updateTime": {},
      "creator": "<string>",
      "updater": "<string>",
      "name": "<string>",
      "description": "<string>",
      "aggregationWindow": {},
      "exposureOffset": {},
      "measurementConfig": {},
      "varianceReductionConfig": {},
      "nullHandling": {},
      "derivedUnit": {},
      "preferredDirection": {},
      "defaultEffectSize": {},
      "filter": {},
      "filterString": "<string>",
      "deleteTime": {},
      "labels": [
        {}
      ],
      "systemCreated": true,
      "owner": "<string>"
    }
  ],
  "nextPageToken": "<string>"
}

Authorizations

Authorization · string · header · required

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

Query Parameters

pageSize · object

The maximum number of metrics to fetch.

pageToken · string

Token used for pagination.

filter · string

Filtering for metrics, follows the lucene query string format for example 'name: "metrics/abc"', see Metric type for available fields.

showDeleted · boolean

If deleted metrics should be included.

orderBy · string

Provide fields and direction to sort by. Will always tiebreak on name. Format: {"<"}field_0{">"}:{"<"}direction{">"}, {"<"}field_1{">"}:{"<"}direction{">"} Example: name:desc,age:asc

Response

200 - application/json

OK

metrics · object[] · required

List of matching metrics.

Show child attributes

nextPageToken · string

Token to fetch the next page, empty if no more pages.