Skip to main content
POST
/
v1
/
metrics
Create Metric
curl --request POST \
  --url https://metrics.eu.confidence.dev/v1/metrics \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "displayName": "<string>",
  "entity": "<string>",
  "factTable": "<string>",
  "typeSpec": {},
  "name": "<string>",
  "description": "<string>",
  "aggregationWindow": {},
  "exposureOffset": {},
  "measurementConfig": {
    "openWindow": {}
  },
  "varianceReductionConfig": {
    "disabled": true,
    "aggregationWindowOverride": {}
  },
  "nullHandling": {
    "replaceMeasureNullWithZero": true,
    "replaceEntityNullWithZero": true
  },
  "preferredDirection": "PREFERRED_DIRECTION_UNSPECIFIED",
  "defaultEffectSize": {
    "value": "<string>"
  },
  "filterString": "<string>",
  "labels": [
    {}
  ],
  "owner": "<string>",
  "etag": "<string>",
  "measurement": "<string>"
}
'
{
  "displayName": "<string>",
  "entity": "<string>",
  "factTable": "<string>",
  "typeSpec": {
    "averageMetricSpec": {
      "aggregation": {
        "type": "AGGREGATION_TYPE_UNSPECIFIED",
        "threshold": {
          "threshold": {
            "value": "<string>"
          },
          "direction": "AGGREGATION_THRESHOLD_DIRECTION_UNSPECIFIED"
        },
        "cap": {
          "min": {
            "value": "<string>"
          },
          "max": {
            "value": "<string>"
          }
        }
      },
      "measurement": {
        "name": "<string>",
        "type": "COLUMN_TYPE_UNSPECIFIED",
        "repeated": true
      }
    },
    "ratioMetricSpec": {
      "numeratorAggregation": {
        "type": "AGGREGATION_TYPE_UNSPECIFIED",
        "threshold": {
          "threshold": {
            "value": "<string>"
          },
          "direction": "AGGREGATION_THRESHOLD_DIRECTION_UNSPECIFIED"
        },
        "cap": {
          "min": {
            "value": "<string>"
          },
          "max": {
            "value": "<string>"
          }
        }
      },
      "denominatorAggregation": {
        "type": "AGGREGATION_TYPE_UNSPECIFIED",
        "threshold": {
          "threshold": {
            "value": "<string>"
          },
          "direction": "AGGREGATION_THRESHOLD_DIRECTION_UNSPECIFIED"
        },
        "cap": {
          "min": {
            "value": "<string>"
          },
          "max": {
            "value": "<string>"
          }
        }
      },
      "numerator": {
        "name": "<string>",
        "type": "COLUMN_TYPE_UNSPECIFIED",
        "repeated": true
      },
      "denominator": {
        "name": "<string>",
        "type": "COLUMN_TYPE_UNSPECIFIED",
        "repeated": true
      },
      "numeratorFilter": {
        "criteria": [
          {}
        ],
        "expression": {
          "ref": "<string>",
          "not": {},
          "and": {
            "operands": [
              {}
            ]
          },
          "or": {
            "operands": [
              {}
            ]
          }
        }
      }
    }
  },
  "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": "BASE_UNIT_UNSPECIFIED",
      "currencyCode": "<string>",
      "customUnit": "<string>",
      "entity": "<string>",
      "factTable": "<string>"
    },
    "denominator": {
      "baseUnitMultiplier": 123,
      "baseUnit": "BASE_UNIT_UNSPECIFIED",
      "currencyCode": "<string>",
      "customUnit": "<string>",
      "entity": "<string>",
      "factTable": "<string>"
    }
  },
  "preferredDirection": "PREFERRED_DIRECTION_UNSPECIFIED",
  "defaultEffectSize": {
    "value": "<string>"
  },
  "filter": {
    "criteria": [
      {}
    ],
    "expression": {
      "ref": "<string>",
      "not": {},
      "and": {
        "operands": [
          {}
        ]
      },
      "or": {
        "operands": [
          {}
        ]
      }
    }
  },
  "filterString": "<string>",
  "deleteTime": {},
  "labels": [
    {}
  ],
  "systemCreated": true,
  "owner": "<string>",
  "etag": "<string>",
  "measurement": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://confidence.spotify.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
metricId
string

The id to the give the created metric. If a not set a random one will be generated.

Body

application/json
​
displayName
string
required

Human friendly name of the metric.

​
entity
string
required

Resource name of the entity that the metric is defined on.

​
factTable
string
required

Resource name of the fact table that the metric is based on.

​
typeSpec
object
required

The kind of metric.

​
name
string

Unique identifier of the metric. For example: metrics/0smva5nxuhv4yts6paxt

​
description
string

Description of the metric.

​
aggregationWindow
object

Size of the window that the measurements are aggregated within the user.

​
exposureOffset
object

Offset relative to the first exposure that measurements should start to be collected.

​
measurementConfig
object

Defines on what time window measurements are aggregated on.

​
varianceReductionConfig
object

Configuration for variance reduction of the metric.

​
nullHandling
object

Determines how NULLs should be handled.

​
preferredDirection
enum<string>

The preferred direction for this metric.

Available options:
PREFERRED_DIRECTION_UNSPECIFIED,
INCREASE,
DECREASE
​
defaultEffectSize
object

The default relative effect size (MDE/NIM) for this metric. Will be used to auto-populate with the effect size when creating a new experiment.

​
filter
object

An optional metric filter that will be used to filter the fact table the metric is derived from.

​
filterString
string

A SQL string version of the metric filter. Set either this or filter when updating the metric.

​
labels
object[]

Custom labels for this metric.

​
owner
string

The owner of the resource. If not set will default to the creator.

​
etag
string

The etag for this metric. Used for optimistic concurrency control.

​
measurement
string

Reference to the measurement that this metric is based on.

Response

200 - application/json

Returns a Metric.

A general description of how to aggregate a measurement from a fact table across entities.

​
displayName
string
required

Human friendly name of the metric.

​
entity
string
required

Resource name of the entity that the metric is defined on.

​
factTable
string
required

Resource name of the fact table that the metric is based on.

​
typeSpec
object
required

The kind of metric.

​
createTime
object
required

Time when the metric was first created.

​
updateTime
object
required

Time when the metric was last updated.

​
creator
string
required

Reference to the identity that created this metric.

​
updater
string
required

Reference to the identity that last updated this metric.

​
name
string

Unique identifier of the metric. For example: metrics/0smva5nxuhv4yts6paxt

​
description
string

Description of the metric.

​
aggregationWindow
object

Size of the window that the measurements are aggregated within the user.

​
exposureOffset
object

Offset relative to the first exposure that measurements should start to be collected.

​
measurementConfig
object

Defines on what time window measurements are aggregated on.

​
varianceReductionConfig
object

Configuration for variance reduction of the metric.

​
nullHandling
object

Determines how NULLs should be handled.

​
derivedUnit
object

The unit inferred for this metric based on the input units of the measures.

​
preferredDirection
enum<string>

The preferred direction for this metric.

Available options:
PREFERRED_DIRECTION_UNSPECIFIED,
INCREASE,
DECREASE
​
defaultEffectSize
object

The default relative effect size (MDE/NIM) for this metric. Will be used to auto-populate with the effect size when creating a new experiment.

​
filter
object

An optional metric filter that will be used to filter the fact table the metric is derived from.

​
filterString
string

A SQL string version of the metric filter. Set either this or filter when updating the metric.

​
deleteTime
object

Time when the metric was deleted.

​
labels
object[]

Custom labels for this metric.

​
systemCreated
boolean

If this metric is an automatically created internal metric.

​
owner
string

The owner of the resource. If not set will default to the creator.

​
etag
string

The etag for this metric. Used for optimistic concurrency control.

​
measurement
string

Reference to the measurement that this metric is based on.