This object is used when setting Key Performance Indicator values. It can be used to set both numeric values or expressions for ranges of dates.
Fields
metric (String!)
The api name of the metric to update.
dataset (String!)
The api name of the dataset to update. Currently “actual__d” and “target__d” are supported.
start (String)
If set, the date this update should start on. If not set, the update will extend backward for all time.
This is formatted as a date, see Date Values for the expected format.
end (String)
If set, the date this update should end on. If not set, the update will extend forward for all time.
This is formatted as a date, see Date Values for the expected format.
value (String)
The value to set the metric to.
This field accepts an expression; see Expressions for supported formats.
Examples
Clear a metric up to a date:
{
metric: "Savings__m"
dataset: "actual__d"
end: "2019-12-31"
value: ""
}
Set a single period in a monthly metric to a specific value:
{
metric: "Savings__m"
dataset: "actual__d"
start: "2019-01-01"
end: "2019-01-31"
value: "5.0"
}
Set the expression for a metric from a specific date forward:
{
metric: "Savings__m"
dataset: "actual__d"
start: "2019-02-01"
value: "=cumulative(Savings__m)"
}