Jump to

• Request
• Response

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 Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Match All

Show Source

• object SuccessfulGetOperation
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulGetOperation"
        },
        {
            "type":"object",
            "properties":{
                "total":{
                    "description":"The total number of results regardless of paging.",
                    "type":"integer",
                    "example":"1"
                },
                "data":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/metricAvailabilityDataRead"
                    }
                }
            }
        }
    ]
}

Nested Schema : SuccessfulGetOperation

Type: object

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

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"true"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Loaded 1 entries"
        }
    },
    "type":"object"
}

Nested Schema : type

Type: object

Show Source

• data: array data
• total: integer
  The total number of results regardless of paging.

  Example: 1

{
    "type":"object",
    "properties":{
        "total":{
            "description":"The total number of results regardless of paging.",
            "type":"integer",
            "example":"1"
        },
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/metricAvailabilityDataRead"
            }
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object metricAvailabilityDataRead

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/metricAvailabilityDataRead"
    }
}

Nested Schema : metricAvailabilityDataRead

Type: object

Show Source

• 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 Name

  Example: router.example.com
• Maximum: integer
  Maximum

  Example: 0
• MetricID: integer
  May be a single value or a comma-separated list

  Example: 642677
• MetricInstanceName: string
  Metric Instance Name

  Example: Device
• MetricTypeName: string
  Metric Type Name

  Example: 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 string

  Example: 1695201840
• StopTime: string
  Epoch time string

  Example: 1695288240
• Unavailability: array Unavailability
  Array of times and percentage of time it was unavailable for that time period. Availability plus Unavailability plus MissingData should add up to 100.

{
    "properties":{
        "DeviceName":{
            "description":"Device Name",
            "type":"string",
            "example":"router.example.com"
        },
        "MetricInstanceName":{
            "description":"Metric Instance Name",
            "type":"string",
            "example":"Device"
        },
        "MetricTypeName":{
            "description":"Metric Type Name",
            "type":"string",
            "example":"Latency"
        },
        "Maximum":{
            "description":"Maximum",
            "type":"integer",
            "example":"0"
        },
        "MetricID":{
            "description":"May be a single value or a comma-separated list",
            "type":"integer",
            "example":642677
        },
        "Unavailability":{
            "description":"Array of times and percentage of time it was unavailable for that time period. Availability plus Unavailability plus MissingData should add up to 100.",
            "type":"array",
            "items":{
                "type":"array",
                "items":{
                    "type":"integer"
                },
                "example":[
                    1.6952004E12,
                    0
                ]
            }
        },
        "Availability":{
            "description":"Array of times and percentage of time it was available for that time period. Availability plus Unavailability plus MissingData should add up to 100.",
            "type":"array",
            "items":{
                "type":"array",
                "items":{
                    "type":"integer"
                },
                "example":[
                    1.6952004E12,
                    100
                ]
            }
        },
        "MissingData":{
            "description":"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.",
            "type":"array",
            "items":{
                "type":"array",
                "items":{
                    "type":"integer"
                },
                "example":[
                    1.6952004E12,
                    0
                ]
            }
        },
        "BlankData":{
            "description":"This is used if the time range goes into the future. It ensures the chart shows the future time properly.",
            "type":"array",
            "items":{
                "type":"array",
                "items":{
                    "type":"integer"
                },
                "example":[
                ]
            }
        },
        "StartTime":{
            "description":"Epoch time string",
            "type":"string",
            "example":1695201840
        },
        "StopTime":{
            "description":"Epoch time string",
            "type":"string",
            "example":1695288240
        },
        "Retention":{
            "description":"The retention period the data is drawn from.",
            "type":"string",
            "example":"raw"
        }
    },
    "type":"object"
}

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

• Array of: array items

{
    "description":"Array of times and percentage of time it was available for that time period. Availability plus Unavailability plus MissingData should add up to 100.",
    "type":"array",
    "items":{
        "type":"array",
        "items":{
            "type":"integer"
        },
        "example":[
            1.6952004E12,
            100
        ]
    }
}

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

• Array of: array items

{
    "description":"This is used if the time range goes into the future. It ensures the chart shows the future time properly.",
    "type":"array",
    "items":{
        "type":"array",
        "items":{
            "type":"integer"
        },
        "example":[
        ]
    }
}

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

• Array of: array items

{
    "description":"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.",
    "type":"array",
    "items":{
        "type":"array",
        "items":{
            "type":"integer"
        },
        "example":[
            1.6952004E12,
            0
        ]
    }
}

Nested Schema : Unavailability

Type: array

Array of times and percentage of time it was unavailable for that time period. Availability plus Unavailability plus MissingData should add up to 100.

Show Source

• Array of: array items

{
    "description":"Array of times and percentage of time it was unavailable for that time period. Availability plus Unavailability plus MissingData should add up to 100.",
    "type":"array",
    "items":{
        "type":"array",
        "items":{
            "type":"integer"
        },
        "example":[
            1.6952004E12,
            0
        ]
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: integer

{
    "type":"array",
    "items":{
        "type":"integer"
    },
    "example":[
        1.6952004E12,
        100
    ]
}

Example:

[
    1.6952004E12,
    100
]

Nested Schema : items

Type: array

Show Source

• Array of: integer

{
    "type":"array",
    "items":{
        "type":"integer"
    },
    "example":[
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: integer

{
    "type":"array",
    "items":{
        "type":"integer"
    },
    "example":[
        1.6952004E12,
        0
    ]
}

Example:

[
    1.6952004E12,
    0
]

Nested Schema : items

Type: array

Show Source

• Array of: integer

{
    "type":"array",
    "items":{
        "type":"integer"
    },
    "example":[
        1.6952004E12,
        0
    ]
}

Example:

[
    1.6952004E12,
    0
]

Default Response

Failed operation

Body ()

Root Schema : schema

Type: object

Show Source

• 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

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"false"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Exception thrown"
        },
        "errors":{
            "description":"The list of errors reported. Validation errors will be keyed by record field.",
            "type":"array",
            "items":{
                "type":"object"
            }
        }
    },
    "type":"object"
}

Nested Schema : errors

Type: array

The list of errors reported. Validation errors will be keyed by record field.

Show Source

• Array of: object items

{
    "description":"The list of errors reported. Validation errors will be keyed by record field.",
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

Back to Top