Interface SnsMetricChange

Interface for all the parts of a metric that can be changed.

interface SnsMetricChange {
    application?: string;
    color?: any;
    country?: string;
    dimensions?: any;
    extendedStatistic?: any;
    label?: any;
    period?: any;
    platform?: string;
    smsType?: "promotional" | "transactional";
    statistic?: any;
    topic?: any;
    unit?: any;
    visible?: any;
    yAxis?: any;
}

Hierarchy (view full)

Properties

application? color? country? dimensions? extendedStatistic? label? period? platform? smsType? statistic? topic? unit? visible? yAxis?

Properties

Optional application

application?: string

Filters on application objects, which represent an app and device registered with one of the supported push notification services, such as APNS and FCM.

Optional color

color?: any

The 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 country

country?: string

Filters 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 dimensions

dimensions?: any

The 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 extendedStatistic

extendedStatistic?: any

The 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 label

label?: any

The 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 period

period?: any

The 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 platform

platform?: string

Filters on platform objects for the push notification services, such as APNS and FCM.

Optional smsType

smsType?: "promotional" | "transactional"

Filters on the message type of SMS message.

Optional statistic

statistic?: any

The 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 topic

topic?: any

Optional topic to filter down to.

Optional unit

unit?: any

The 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 visible

visible?: any

Set 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 yAxis

yAxis?: any

Where 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].

Settings

Member Visibility

Theme

On This Page

applicationcolorcountrydimensionsextendedStatisticlabelperiodplatformsmsTypestatistictopicunitvisibleyAxis

Generated using TypeDoc