Get Information About Metrics that can be Graphed
get
/api/metric/PerformanceData/readMetrics
Gets information about existing metrics that can be graphed.
Request
Query Parameters
-
MetricID:
Match All
-
string
Metric ID (or multiple, comma-separated Metric IDs)Example:
154
-
string
-
filter: object
The fields to filter the results by. You cannot filter by fields that contain a state.
This parameter's value uses the following JSON format:
{
"property": "property",
"value": "propertyValue",
"operator": "operator",
"conjunction": "conjunction"
}
If you use multiple JSON objects to combine filters, for example, to filter by several different device names, you cannot combine OR and AND conjunctions. The conjunction used for the last object applies to the entire list.-
conjunction:
string
Default Value:
OR
Allowed Values:[ "AND", "OR" ]
The conjunction between filters.Example:AND
-
operator:
string
Default Value:
LIKE
Allowed Values:[ "eq", "ne", "gte", "gt", "lte", "lt", "LIKE", "NOT LIKE", "re", "not re", "NOT IN" ]
The filter operation to use.Example:eq
-
property(required):
string
The name of the field to filter on.Example:
name
-
value(required):
string
The value of the field to filter on.Example:
test
-
conjunction:
string
-
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 information that can be graphed.
-
total: integer
The total number of results regardless of paging.Example:
1
Nested Schema : metricPerformanceDataReadMetrics
Type:
Show Source
object
-
DeviceID: string
Device ID (or multiple, comma-separated Device IDs)Example:
40
-
DeviceMetricID: string
Device ID and Metric ID concatenated with a hyphen "-"Example:
40-154
-
DeviceName: string
Device Name (or multiple, comma-separated Device Names)Example:
router.example.com
-
DeviceZoneName: string
Device zone nameExample:
Default First Zone
-
DisplayInstanceName: string
Metric Display (custom) Instance NameExample:
Device
-
InstanceName: string
Metric Instance NameExample:
Device
-
MetricID: string
Metric ID (or multiple, comma-separated Metric IDs)Example:
154
-
MetricTypeName: string
Metric Type NameExample:
Latency
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