Skip to main content
GET
/
v1
/
metrics
List Metric
curl --request GET \
  --url https://metrics.eu.confidence.dev/v1/metrics \
  --header 'Authorization: Bearer <token>'
{
  "metrics": [
    {
      "displayName": "<string>",
      "entity": "<string>",
      "factTable": "<string>",
      "typeSpec": {
        "averageMetricSpec": {
          "aggregation": {
            "type": {},
            "threshold": {
              "threshold": {
                "value": "<string>"
              },
              "direction": {}
            },
            "cap": {
              "min": {
                "value": "<string>"
              },
              "max": {
                "value": "<string>"
              }
            }
          },
          "measurement": {
            "name": "<string>",
            "type": {},
            "repeated": true
          }
        },
        "ratioMetricSpec": {
          "numeratorAggregation": {
            "type": {},
            "threshold": {
              "threshold": {
                "value": "<string>"
              },
              "direction": {}
            },
            "cap": {
              "min": {
                "value": "<string>"
              },
              "max": {
                "value": "<string>"
              }
            }
          },
          "denominatorAggregation": {
            "type": {},
            "threshold": {
              "threshold": {
                "value": "<string>"
              },
              "direction": {}
            },
            "cap": {
              "min": {
                "value": "<string>"
              },
              "max": {
                "value": "<string>"
              }
            }
          },
          "numerator": {
            "name": "<string>",
            "type": {},
            "repeated": true
          },
          "denominator": {
            "name": "<string>",
            "type": {},
            "repeated": true
          }
        }
      },
      "createTime": {},
      "updateTime": {},
      "creator": "<string>",
      "updater": "<string>",
      "name": "<string>",
      "description": "<string>",
      "aggregationWindow": {},
      "exposureOffset": {},
      "measurementConfig": {
        "closedWindow": {
          "aggregationWindow": {},
          "exposureOffset": {}
        },
        "semiOpenWindow": {
          "aggregationWindow": {},
          "exposureOffset": {}
        },
        "openWindow": {}
      },
      "varianceReductionConfig": {
        "disabled": true,
        "aggregationWindowOverride": {}
      },
      "nullHandling": {
        "replaceMeasureNullWithZero": true,
        "replaceEntityNullWithZero": true
      },
      "derivedUnit": {
        "numerator": {
          "baseUnitMultiplier": 123,
          "baseUnit": {},
          "currencyCode": "<string>",
          "customUnit": "<string>",
          "entity": "<string>",
          "factTable": "<string>"
        },
        "denominator": {
          "baseUnitMultiplier": 123,
          "baseUnit": {},
          "currencyCode": "<string>",
          "customUnit": "<string>",
          "entity": "<string>",
          "factTable": "<string>"
        }
      },
      "preferredDirection": {},
      "defaultEffectSize": {
        "value": "<string>"
      },
      "filter": {
        "criteria": [
          {}
        ],
        "expression": {
          "ref": "<string>",
          "not": {},
          "and": {
            "operands": [
              {}
            ]
          },
          "or": {
            "operands": [
              {}
            ]
          }
        }
      },
      "filterString": "<string>",
      "deleteTime": {},
      "labels": [
        {}
      ],
      "systemCreated": true,
      "owner": "<string>",
      "etag": "<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
Metric · object[]
required

Metric: List of matching metrics.

​
nextPageToken
string

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