Jump to

• Request
• Response

Get a Measurement by Name

get

/api/metric/Measurements/{name}

Gets the measurement that matches the specified name. This can be a measurement name, prefixed with metrictype_, or a metric type name.

Request

Path Parameters

• name(required): string
  The name of the measurement to get. This can be a measurement name, prefixed with metrictype_, or a metric type name.

  Examples

  Select an example metricTypeName measurementName

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":{
                "data":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/metricMeasurementsRead"
                    }
                }
            }
        }
    ]
}

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

{
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/metricMeasurementsRead"
            }
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object metricMeasurementsRead

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

Nested Schema : metricMeasurementsRead

Type: object

Show Source

• description: string
  The metric type name for the measurement.

  Example: Interface Inbound Bandwidth
• measurement: string
  The measurement ID.

  Example: metrictype_Interface_Inbound_Bandwidth

{
    "properties":{
        "measurement":{
            "description":"The measurement ID.",
            "type":"string",
            "example":"metrictype_Interface_Inbound_Bandwidth"
        },
        "description":{
            "description":"The metric type name for the measurement.",
            "type":"string",
            "example":"Interface Inbound Bandwidth"
        }
    },
    "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