Jump to

• Request
• Response

Get Metric Types

get

/api/metric/Types

Gets the metric types that match the specified query parameters. If no parameters are specified, all metric types are returned.

Request

Query Parameters

• limit: integer(int32)
  The number of records to limit results by. If you do not also set the start parameter, records start at 0.

  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",
      "example":[
          {
              "property":"Name",
              "direction":"ASC"
          },
          {
              "property":"Value",
              "direction":"DESC"
          }
      ]
  }

  Example:

  [
      {
          "property":"Name",
          "direction":"ASC"
      },
      {
          "property":"Value",
          "direction":"DESC"
      }
  ]

• start: integer(int32)
  The page of results to start from. This parameter is ignored if you do not also set the limit parameter.

  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
  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",
                    "description":"The metric types that match the specified query parameters.",
                    "items":{
                        "$ref":"#/components/schemas/metricTypesRead"
                    }
                }
            }
        }
    ]
}

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
  The metric types that match the specified query parameters.
• 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",
            "description":"The metric types that match the specified query parameters.",
            "items":{
                "$ref":"#/components/schemas/metricTypesRead"
            }
        }
    }
}

Nested Schema : data

Type: array

The metric types that match the specified query parameters.

Show Source

• Array of: object metricTypesRead

{
    "type":"array",
    "description":"The metric types that match the specified query parameters.",
    "items":{
        "$ref":"#/components/schemas/metricTypesRead"
    }
}

Nested Schema : metricTypesRead

Type: object

Show Source

• Abbr: string
  Type Abbreviation

  Example: Conn
• Direction: integer
  Direction Allowed Values: - 0 => Descending (Normal) - 1 => Ascending

  Example: 0
• DirectionName: string
  Sort direction Allowed Values: - Descending (Normal) - Ascending

  Example: Descending (Normal)
• FormatID: integer
  Format ID Allowed Values: - 0 => Integer - 1 => Float

  Example: 0
• FormatName: string
  Format. Allowed Values: - Integer - Float

  Example: Integer
• Measurement: string
  Measurement

  Example: metrictype_Apache_Accesses
• MetricGroupID: integer
  Metric Group ID

  Example: 141
• MetricGroupName: string
  Metric Group Name for displaying metrics together

  Example: Network Traffic
• MetricTypeID: integer
  Metric Type ID

  Example: 515
• MetricTypeName: string
  Metric Type Name

  Example: Apache Accesses
• TopNScopeID: integer
  TopNScope Allowed Values: - 0 => Disabled - 1 => Utilization - 2 => Value - 3 => Both

  Example: 0
• TopNScopeName: string
  TopN scope Allowed Values: - Disabled - Utilization - Value - Both

  Example: Disabled
• TopNTypeID: integer
  TopN Type Allowed Values: - 0 => Both - 1 => Average - 2 => Peak

  Example: 0
• TopNTypeName: string
  TopN Type Allowed Values: - Both - Average - Peak

  Example: Both
• Unit: string
  Type Unit

  Example: Connections
• UnitDivisionID: integer
  UnitDivisionID Allowed Values: - 0 => None - 60 => Time - 1000 => SI (1000) - 1023 => Deprecated Binary (1000) - 1024 => Binary/IEC (1024)

  Example: 0
• UnitDivisionName: string
  Unit division Allowed values - None - Time - SI(1000) - Deprecated Binary(1000) - Binary/IEC(1024)

  Example: None
• ValueType: integer
  Value type Allowed Values: - 0 => Raw - 100 => Utilization

  Example: 0
• ValueTypeName: string
  Value type name Allowed Values: - Raw - Utilization

  Example: Raw

{
    "properties":{
        "MetricTypeID":{
            "description":"Metric Type ID",
            "type":"integer",
            "example":"515"
        },
        "MetricTypeName":{
            "description":"Metric Type Name",
            "type":"string",
            "example":"Apache Accesses"
        },
        "MetricGroupID":{
            "description":"Metric Group ID",
            "type":"integer",
            "example":"141"
        },
        "Measurement":{
            "description":"Measurement",
            "type":"string",
            "example":"metrictype_Apache_Accesses"
        },
        "MetricGroupName":{
            "description":"Metric Group Name for displaying metrics together",
            "type":"string",
            "example":"Network Traffic"
        },
        "FormatID":{
            "description":"Format ID \nAllowed Values:\n-  0 => Integer\n-  1 => Float",
            "type":"integer",
            "example":"0"
        },
        "FormatName":{
            "description":"Format. \n\nAllowed Values:\n- Integer\n- Float",
            "type":"string",
            "example":"Integer"
        },
        "Unit":{
            "description":"Type Unit",
            "type":"string",
            "example":"Connections"
        },
        "Abbr":{
            "description":"Type Abbreviation",
            "type":"string",
            "example":"Conn"
        },
        "ValueType":{
            "description":"Value type\n\nAllowed Values:\n-  0 => Raw\n-  100 => Utilization",
            "type":"integer",
            "example":"0"
        },
        "ValueTypeName":{
            "description":"Value type name\n\nAllowed Values:\n- Raw\n- Utilization",
            "type":"string",
            "example":"Raw"
        },
        "Direction":{
            "description":"Direction\n\nAllowed Values:\n-  0 => Descending (Normal)\n-  1 => Ascending",
            "type":"integer",
            "example":"0"
        },
        "DirectionName":{
            "description":"Sort direction\n\nAllowed Values:\n- Descending (Normal)\n- Ascending",
            "type":"string",
            "example":"Descending (Normal)"
        },
        "TopNTypeID":{
            "description":"TopN Type\n\nAllowed Values:\n-  0 => Both\n-  1 => Average\n-  2 => Peak",
            "type":"integer",
            "example":"0"
        },
        "TopNTypeName":{
            "description":"TopN Type\n\nAllowed Values:\n- Both\n- Average\n- Peak",
            "type":"string",
            "example":"Both"
        },
        "TopNScopeID":{
            "description":"TopNScope\n\nAllowed Values:\n-  0 => Disabled\n-  1 => Utilization\n-  2 => Value\n-  3 => Both",
            "type":"integer",
            "example":"0"
        },
        "TopNScopeName":{
            "description":"TopN scope\n\nAllowed Values:\n- Disabled\n- Utilization\n- Value\n- Both",
            "type":"string",
            "example":"Disabled"
        },
        "UnitDivisionID":{
            "description":"UnitDivisionID\n\nAllowed Values:\n-  0 => None\n-  60 => Time\n-  1000 => SI (1000)\n-  1023 => Deprecated Binary (1000)\n-  1024 => Binary/IEC (1024)",
            "type":"integer",
            "example":"0"
        },
        "UnitDivisionName":{
            "description":"Unit division\n\nAllowed values\n- None\n- Time\n- SI(1000)\n- Deprecated Binary(1000)\n- Binary/IEC(1024)",
            "type":"string",
            "example":"None"
        }
    },
    "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":{
                "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.

Back to Top