Get Availability Data for the Metrics of an Instance
get
/api/metric/AvailabilityData/read
Gets availability data for metrics of the specified instance.
Request
Query Parameters
-
DeviceName(required): string
The device name corresponding to Devices.DeviceName.Example:
router.example.com
-
DeviceZoneName(required): string
The device zone name.Example:
Oracle Lab - Network Equipment
-
InstanceName(required): string
The metric instance name corresponding to metricInstances.Example:
Device
-
MetricType(required): string
The metric type name corresponding to MetricTypes.MetricTypeName.Example:
Latency
-
TimeRange(required): string
A shorthand string that encompasses StartTime and StopTime. Overwrites any value set for Start and StopTime. If no value is provided, the most recent 24 hour period is used.Example:
now-24h..now
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
-
total: integer
The total number of results regardless of paging.Example:
1
Nested Schema : metricAvailabilityDataRead
Type:
Show Source
object
-
Availability: array
Availability
Array of times and percentage of time it was available for that time period. Availability plus Unavailability plus MissingData should add up to 100.
-
BlankData: array
BlankData
This is used if the time range goes into the future. It ensures the chart shows the future time properly.
-
DeviceName: string
Device NameExample:
router.example.com
-
Maximum: integer
MaximumExample:
0
-
MetricID: integer
May be a single value or a comma-separated listExample:
642677
-
MetricInstanceName: string
Metric Instance NameExample:
Device
-
MetricTypeName: string
Metric Type NameExample:
Latency
-
MissingData: array
MissingData
Array of times and percentage of time there was no data for that time period. Availability plus Unavailability plus MissingData should add up to 100.
-
Retention: string
The retention period the data is drawn from.Example:
raw
-
StartTime: string
Epoch time stringExample:
1695201840
-
StopTime: string
Epoch time stringExample:
1695288240
- Unavailability: array Unavailability
Nested Schema : Availability
Type:
array
Array of times and percentage of time it was available for that time period. Availability plus Unavailability plus MissingData should add up to 100.
Show Source
Nested Schema : BlankData
Type:
array
This is used if the time range goes into the future. It ensures the chart shows the future time properly.
Show Source
Nested Schema : MissingData
Type:
array
Array of times and percentage of time there was no data for that time period. Availability plus Unavailability plus MissingData should add up to 100.
Show Source
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