Create a Metric
post
/api/metric/Metrics
Creates a new metric.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
CustomMaximum: number
Metric Custom Maximum to override auto maximum
-
DeviceName: string
Device Name. The name will be CustomName, DNSName, SysName, IPv6Address, or IPAddress. Whichever value is found first is used.Example:
device.example.com
-
DeviceZoneName: string
The zone the device is assigned to.Example:
Default First Zone
-
Factor: integer
FactorExample:
1
-
InstanceID: integer
ID of Instance from Assure1.metricInstancesExample:
0
-
Maximum: integer
MaximumExample:
100
-
MethodID: integer
ID from Assure1.MetricMethodsExample:
0
-
MetricTypeID: integer
ID of Metric Type from Assure1.MetricTypesExample:
63
-
PollTime: integer
Metric collection interval (used for display only)Example:
300
-
ShardID: integer
ID of the shard the metric resides onExample:
1
-
StatusID: integer
Metric Status | Allowed Values: | 0 => Disabled | 1 => EnabledExample:
1
-
Thresholds: array
Thresholds
collection of assigned thresholds
Response
Supported Media Types
- application/json
200 Response
Successful operation
Nested Schema : SuccessfulAddOperation
Type:
Show Source
object
-
message: string
The response message.Example:
Added record
-
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
true
Nested Schema : type
Type:
Show Source
object
-
data: array
data
-
total: integer
The total number of results regardless of paging.Example:
1
Nested Schema : metricMetricsRead
Type:
Show Source
object
-
Abbr: string
Metric AbbreviationExample:
%
-
CustomMaximum: number
Metric Custom Maximum to override auto maximum
-
DeviceHost: string
Device Host. The host is DNSName, IPv6Address, or IPAddress.Example:
191.1.1.44
-
DeviceID: integer
ID of Device from Assure1.DevicesExample:
1599
-
DeviceName: string
Device Name. The name will be CustomName, DNSName, SysName, IPv6Address, or IPAddress. Whichever value is found first is used.Example:
460056A
-
DeviceShardID: integer
Device Shard IDExample:
1
-
DeviceZoneID: integer
Device Zone IDExample:
1
-
DeviceZoneName: string
Device Zone NameExample:
Default First Zone
-
DisplayInstanceName: string
Display Instance NameExample:
1 Minute Average
-
Factor: integer
FactorExample:
1
-
InstanceID: integer
ID of Instance from Assure1.metricInstancesExample:
0
-
InstanceName: string
Instance NameExample:
Device
-
Maximum: integer
MaximumExample:
100
-
Measurement: string
The influxDB measurement name.Example:
metrictype_Ping_Jitter_Utilization
-
MethodID: integer
ID from Assure1.MetricMethodsExample:
0
-
MethodName: string
Method NameExample:
NA
-
MetricID: integer
Metric IDExample:
587889
-
MetricName: string
Metric NameExample:
Device
-
MetricTypeID: integer
ID of Metric Type from Assure1.MetricTypesExample:
63
-
MetricTypeName: string
Metric Type NameExample:
Ping Jitter Utilization
-
PollTime: integer
Metric collection interval (used for display only)Example:
300
-
ShardID: integer
ID of the shard the metric resides onExample:
1
-
StateIcon: string
Flag to indicate if the metric has data. Allowed values:- "OrbGreen.png" or "OrbYellow.png"Example:
OrbYellow.png
-
StateName: string
Flag to indicate if the metric has data. Allowed values:- "Data Exists" or "No Data"Example:
No Data
-
StatusIcon: string
Status IconExample:
OrbGreen.png
-
StatusID: integer
Metric Status | Allowed Values: | 0 => Disabled | 1 => EnabledExample:
1
-
StatusName: string
Status NameExample:
Enabled
-
Thresholds: array
Thresholds
collection of assigned thresholds
-
Unit: string
Unit of the metric type, i.e. Seconds, Errors, Bits per Second, etc.Example:
Percent
-
UnitDivision: integer
Unit division Allowed Values: - 0 => None - 60 => Time - 1000 => SI (1000) - 1024 => Binary/IEC (1024)Example:
0
Nested Schema : items
Type:
Show Source
object
-
Measurement: string
MeasurementExample:
metrictype_Ping_Jitter_Utilization
-
ThresholdID: integer
Threshold IDExample:
19
-
ThresholdName: string
Threshold NameExample:
Ping Jitter Utilization High
Default Response
Failed operation
Root Schema : schema
Type:
Show Source
object
-
errors: array
errors
The list of errors reported. Validation errors will be keyed by record field.
-
message: string
The response message.Example:
Exception thrown
-
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
false
Nested Schema : errors
Type:
array
The list of errors reported. Validation errors will be keyed by record field.
Show Source
Nested Schema : items
Type:
object