Get Metric

Get a metric.

GET /v1/metrics/{metric}

Get Metric

cURL

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

200

{
  "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>"
}

Authorizations

Authorization · string · header · required

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

Path Parameters

metric · string · required

Response

200 - application/json

OK

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 · object

The preferred direction for this metric.

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.

Show child attributes

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.