Get a Measurement by ID
get
/api/metric/Measurements/{description}
Gets the measurement that matches the specified ID.
Request
Path Parameters
-
description(required): string
The description of the measurement to get. This is usually the name of the metric type for the measurement.Example:
Interface Inbound Bandwidth
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : schema
Match All
Show Source
-
object
SuccessfulGetOperation
The response body for a successful get operation.
-
object
type
Nested Schema : SuccessfulGetOperation
Type:
object
The response body for a successful get operation.
Show Source
-
message: string
The response message.Example:
Loaded 1 entries
-
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
true
Nested Schema : metricMeasurementsRead
Type:
Show Source
object
-
description: string
The metric type name for the measurement.Example:
Interface Inbound Bandwidth
-
measurement: string
The measurement ID.Example:
metrictype_Interface_Inbound_Bandwidth
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
-
Array of:
object items
An error.
Nested Schema : items
Type:
object
An error.