Skip to main content

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.