Skip to main content
POST
/
v1
/
metrics:suggestMetric
Suggest Metric
curl --request POST \
  --url https://metrics.eu.confidence.dev/v1/metrics:suggestMetric \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "displayName": "<string>",
  "description": "<string>"
}
'
{
  "metric": {
    "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>"
  },
  "error": "<string>"
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
displayName
string

The title of the metric that you want to create.

​
description
string

The description of the metric that you want to create.

Response

200 - application/json

OK

​
metric
Metric · object

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

​
error
string

an error message if the suggestion failed.