REST API for Unified Assurance Core

Get Metric Availability Data

get

/api/metric/AvailabilityData/read

Gets availability data for metrics of the specified instance.
Valid request combinations:

Serialized device name

/api/metric/AvailabilityData/read?DeviceName=router.example.com;z3&MetricType=Latency&InstanceName=Device&TimeRange=now-24h..now

Device name and device zone

/api/metric/AvailabilityData/read?DeviceName=router.example.com&DeviceZoneID=3&MetricType=Latency&InstanceName=Device&TimeRange=now-24h..now

Request

Query Parameters

DeviceName(required):
Match All
- string
  
  The serialized device name (or multiple, comma-separated serialized device names). The device name may be serialized (include the zone id) or just the name if the zone is included separately.
  
  Example: router.example.com OR router.example.com;z1
```
{
    "allOf":[
        {
            "$ref":"#/components/schemas/metricPerformanceData/properties/DeviceName"
        }
    ]
}
```
DeviceZoneID: integer
The ID of the device zone to get performance data for. Deprecated. Use serialized device name instead.
Example:
```
1
```
InstanceName(required): string
The metric instance name corresponding to metricInstances.
Example:
```
Device
```

MetricType(required):

Match All

string

Metric Type Name (or multiple, comma-separated Metric Type Names)

Example: Latency

{
    "allOf":[
        {
            "$ref":"#/components/schemas/metricPerformanceData/properties/MetricType"
        }
    ]
}

TimeRange:
Match All
- string
  
  Shorthand string that encompasses the start and end times in RFC3339 format or relative time literal format. It will take precedence over StartTime if both are passed in.
  
  Example: now-24h..now
```
{
    "allOf":[
        {
            "$ref":"#/components/parameters/TimeRange"
        }
    ]
}
```

There's no request body for this operation.

Response

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

{
    "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

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

{
    "description":"The response body for a successful get operation.",
    "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":[
                    "1695200400000",
                    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":[
                    "1695200400000",
                    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":[
                    "1695200400000",
                    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":[
            "1695200400000",
            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":[
            "1695200400000",
            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":[
            "1695200400000",
            0
        ]
    }
}

Nested Schema : items

Type: array

Show Source

Array of: integer

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

Example:

[
    "1695200400000",
    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":[
        "1695200400000",
        0
    ]
}

Example:

[
    "1695200400000",
    0
]

Nested Schema : items

Type: array

Show Source

Array of: integer

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

Example:

[
    "1695200400000",
    0
]

Default Response

Failed operation

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":{
                "description":"An error.",
                "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

An error.

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

Nested Schema : items

Type: object

An error.

Examples

The following examples show how to use query parameters in Get Availability Data requests.

You can submit requests using cURL, an API client, or your browser.

To get availability data for metrics using a serialized device name (device name followed by zone number, router.example.com;z3):

http://hostFQDN/api/metric/AvailabilityData/read?DeviceName=router.example.com;z3&MetricType=Latency&InstanceName=Device&TimeRange=now-24h..now

To get availability data for metrics using a device name and device zone in separate parameters (DeviceName=router.example.com&DeviceZoneID=3):

http://hostFQDN/api/metric/AvailabilityData/read?DeviceName=router.example.com&DeviceZoneID=3&MetricType=Latency&InstanceName=Device&TimeRange=now-24h..now

Example of the Response Body

The following example shows the contents of a response body in JSON format:

{
  "success": "true",
  "message": "Loaded 1 entries",
  "total": "1",
  "data": [
    {
      "DeviceName": "router.example.com",
      "MetricInstanceName": "Device",
      "MetricTypeName": "Latency",
      "Maximum": "0",
      "MetricID": 642677,
      "Unavailability": [
        [
          1695200400000,
          0
        ]
      ],
      "Availability": [
        [
          1695200400000,
          100
        ]
      ],
      "MissingData": [
        [
          1695200400000,
          0
        ]
      ],
      "BlankData": [
        []
      ],
      "StartTime": 1695201840,
      "StopTime": 1695288240,
      "Retention": "raw"
    }
  ]
}