Jump to

• Request
• Response

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

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

• 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

  {
      "required":[
          "property",
          "value"
      ],
      "properties":{
          "property":{
              "description":"The name of the field to filter on.",
              "type":"string",
              "example":"name"
          },
          "value":{
              "description":"The value of the field to filter on.",
              "type":"string",
              "example":"test"
          },
          "operator":{
              "description":"The filter operation to use.",
              "type":"string",
              "default":"LIKE",
              "enum":[
                  "eq",
                  "ne",
                  "gte",
                  "gt",
                  "lte",
                  "lt",
                  "LIKE",
                  "NOT LIKE",
                  "re",
                  "not re",
                  "NOT IN"
              ],
              "example":"eq"
          },
          "conjunction":{
              "description":"The conjunction between filters.",
              "type":"string",
              "default":"OR",
              "enum":[
                  "AND",
                  "OR"
              ],
              "example":"AND"
          }
      },
      "type":"object"
  }

• 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

  {
      "required":[
          "property",
          "direction"
      ],
      "properties":{
          "property":{
              "description":"The field to sort on.",
              "type":"string",
              "example":"name"
          },
          "direction":{
              "description":"The direction of the sort.",
              "type":"string",
              "enum":[
                  "ASC",
                  "DESC"
              ],
              "example":"ASC"
          }
      },
      "type":"object"
  }

• 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 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":{
                    "description":"The metric information that can be graphed.",
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/metricPerformanceDataReadMetrics"
                    }
                }
            }
        }
    ]
}

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
  The metric information that can be graphed.
• 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":{
            "description":"The metric information that can be graphed.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/metricPerformanceDataReadMetrics"
            }
        }
    }
}

Nested Schema : data

Type: array

The metric information that can be graphed.

Show Source

• Array of: object metricPerformanceDataReadMetrics

{
    "description":"The metric information that can be graphed.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/metricPerformanceDataReadMetrics"
    }
}

Nested Schema : metricPerformanceDataReadMetrics

Type: object

Show Source

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

  Example: Default First Zone
• DisplayInstanceName: string
  Metric Display (custom) Instance Name

  Example: Device
• InstanceName: string
  Metric Instance Name

  Example: Device
• MetricID: string
  Metric ID (or multiple, comma-separated Metric IDs)

  Example: 154
• MetricTypeName: string
  Metric Type Name

  Example: Latency

{
    "properties":{
        "MetricID":{
            "$ref":"#/components/schemas/metricPerformanceData/properties/MetricID"
        },
        "DeviceID":{
            "$ref":"#/components/schemas/metricPerformanceData/properties/DeviceID"
        },
        "DeviceMetricID":{
            "description":"Device ID and Metric ID concatenated with a hyphen \"-\"",
            "type":"string",
            "example":"40-154"
        },
        "DeviceName":{
            "$ref":"#/components/schemas/metricPerformanceData/properties/DeviceName"
        },
        "DeviceZoneName":{
            "description":"Device zone name",
            "type":"string",
            "example":"Default First Zone"
        },
        "MetricTypeName":{
            "$ref":"#/components/schemas/metricPerformanceDataRead/properties/MetricTypeName"
        },
        "InstanceName":{
            "$ref":"#/components/schemas/metricPerformanceDataRead/properties/InstanceName"
        },
        "DisplayInstanceName":{
            "$ref":"#/components/schemas/metricPerformanceDataRead/properties/MetricInstanceName"
        }
    },
    "type":"object"
}

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