Suggest Metric

Suggests a metric based on a title and / or description

POST /v1/metrics:suggestMetric

Suggest Metric

cURL

curl --request POST \
  --url https://metrics.eu.confidence.dev/v1/metrics:suggestMetric \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

200

{
  "metric": {
    "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>"
  },
  "error": "<string>"
}

Authorizations

Authorization · string · header · required

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

Body

application/json

The body is of type object.

Response

200 - application/json

OK

metric · object

The suggested metric, empty if no suggestion could be made.

Show child attributes

error · string

an error message if the suggestion failed.