Get Metric Types
get
/api/metric/Types
Gets the metric types that match the specified query parameters. If no parameters are specified, all metric types are returned.
Request
Query Parameters
-
limit: integer(int32)
The number of records to limit results by.Example:
100
-
sort: object
The field and direction to sort results by. You cannot sort by fields that contain a state.
This parameters value uses the following JSON format:
{
"property": "property",
"direction": "direction"
}-
direction(required):
string
Allowed Values:
[ "ASC", "DESC" ]
The direction of the sort.Example:ASC
-
property(required):
string
The field to sort on.Example:
name
-
direction(required):
string
-
start: integer(int32)
The page of results to start from.Default Value:
0
Example:1
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Nested Schema : SuccessfulGetOperation
Type:
Show Source
object
-
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 : type
Type:
Show Source
object
-
data: array
data
The metric types that match the specified query parameters.
-
total: integer
The total number of results regardless of paging.Example:
1
Nested Schema : data
Type:
array
The metric types that match the specified query parameters.
Show Source
Nested Schema : metricTypesRead
Type:
Show Source
object
-
Abbr: string
Type AbbreviationExample:
Conn
-
Direction: integer
Direction Allowed Values: - 0 => Descending (Normal) - 1 => AscendingExample:
0
-
DirectionName: string
Sort direction Allowed Values: - Descending (Normal) - AscendingExample:
Descending (Normal)
-
FormatID: integer
Format ID Allowed Values: - 0 => Integer - 1 => FloatExample:
0
-
FormatName: string
Format. Allowed Values: - Integer - FloatExample:
Integer
-
Measurement: string
MeasurementExample:
metrictype_Apache_Accesses
-
MetricGroupID: integer
Metric Group IDExample:
141
-
MetricGroupName: string
Metric Group Name for displaying metrics togetherExample:
Network Traffic
-
MetricTypeID: integer
Metric Type IDExample:
515
-
MetricTypeName: string
Metric Type NameExample:
Apache Accesses
-
TopNScopeID: integer
TopNScope Allowed Values: - 0 => Disabled - 1 => Utilization - 2 => Value - 3 => BothExample:
0
-
TopNScopeName: string
TopN scope Allowed Values: - Disabled - Utilization - Value - BothExample:
Disabled
-
TopNTypeID: integer
TopN Type Allowed Values: - 0 => Both - 1 => Average - 2 => PeakExample:
0
-
TopNTypeName: string
TopN Type Allowed Values: - Both - Average - PeakExample:
Both
-
Unit: string
Type UnitExample:
Connections
-
UnitDivisionID: integer
UnitDivisionID Allowed Values: - 0 => None - 60 => Time - 1000 => SI (1000) - 1023 => Deprecated Binary (1000) - 1024 => Binary/IEC (1024)Example:
0
-
UnitDivisionName: string
Unit division Allowed values - None - Time - SI(1000) - Deprecated Binary(1000) - Binary/IEC(1024)Example:
None
-
ValueType: integer
Value type Allowed Values: - 0 => Raw - 100 => UtilizationExample:
0
-
ValueTypeName: string
Value type name Allowed Values: - Raw - UtilizationExample:
Raw
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