Optional
applicationFilters on application objects, which represent an app and device registered with one of the supported push notification services, such as APNS and FCM.
Optional
colorThe six-digit HTML hex color code to be used for this metric.
Only used if this metric is displayed in a [Dashboard] with a [MetricWidget].
Optional
countryFilters on the destination country or region of an SMS message. The country or region is represented by its ISO 3166-1 alpha-2 code.
Optional
dimensionsThe new dimension for this metric. If this object is missing this property, then no change will be made. However, if the property is there by set to [undefined] then the value will be cleared.
Optional
extendedThe new percentile statistic for the metric associated with the alarm. If this object is missing this property, then no change will be made. However, if the property is there by set to [undefined] then the value will be set to the default.
Optional
labelThe label to display for this metric in the graph legend. If this is not specified, the metric is given an autogenerated label that distinguishes it from the other metrics in the widget.
Only used if this metric is displayed in a [Dashboard] with a [MetricWidget].
Optional
periodThe new period in seconds over which the specified stat
is applied. If this object is
missing this property, then no change will be made. However, if the property is there by set
to [undefined] then the value will be set to the default (300s).
Optional
platformFilters on platform objects for the push notification services, such as APNS and FCM.
Optional
smsFilters on the message type of SMS message.
Optional
statisticThe new statistic to apply to the alarm's associated metric. If this object is missing this property, then no change will be made. However, if the property is there by set to [undefined] then the value will be set to the default.
Optional
topicOptional topic to filter down to.
Optional
unitThe new unit for this metric. If this object is missing this property, then no change will be made. However, if the property is there by set to [undefined] then the value will be set to the default.
Optional
visibleSet this to true to have the metric appear in the graph, or false to have it be hidden. The default is true.
Only used if this metric is displayed in a [Dashboard] with a [MetricWidget].
Optional
yWhere on the graph to display the y-axis for this metric. The default is left.
Only used if this metric is displayed in a [Dashboard] with a [MetricWidget].
Generated using TypeDoc
Interface for all the parts of a metric that can be changed.