Jump to

• Request
• Response

Get Metric Transactions

get

/api/metric/Transactions

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

Request

Query Parameters

• 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. 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 transactions that match the specified query parameters.",
                    "items":{
                        "$ref":"#/components/schemas/metricTransactionsRead"
                    }
                }
            }
        }
    ]
}

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 transactions 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 transactions that match the specified query parameters.",
            "items":{
                "$ref":"#/components/schemas/metricTransactionsRead"
            }
        }
    }
}

Nested Schema : data

Type: array

The metric transactions that match the specified query parameters.

Show Source

• Array of: object metricTransactionsRead

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

Nested Schema : metricTransactionsRead

Type: object

Show Source

• MetricTypeID: integer
  Metric Type associated to Transaction

  Example: 90
• MetricTypeName: string
  Metric Type Name

  Example: Response Times
• TransactionDescription: string
  Transaction Description

  Example: Using Mechanize library to parse a web site and verify how long it takes to load and if it returns a search criteria
• TransactionID: integer
  Transaction ID

  Example: 2
• TransactionName: string
  Transaction Name

  Example: Web Transaction
• TransactionStatus: string
  Transaction Status Allowed values: - Disable - Enabled

  Example: Enabled
• TransactionStatusIcon: string
  Transaction Status Icon Allowed values - OrbRed.png - OrbGreen.png

  Example: OrbGreen.png
• TransactionStatusID: integer
  The transaction status ID. Either 0 (disabled) or 1 (enabled).

  Example: 1
• TransactionText: string
  Content of Transaction

  Example:

{
    "properties":{
        "TransactionID":{
            "description":"Transaction ID",
            "type":"integer",
            "example":"2"
        },
        "TransactionName":{
            "description":"Transaction Name",
            "type":"string",
            "example":"Web Transaction"
        },
        "TransactionStatusIcon":{
            "description":"Transaction Status Icon\n\nAllowed values\n- OrbRed.png\n- OrbGreen.png",
            "type":"string",
            "example":"OrbGreen.png"
        },
        "TransactionStatus":{
            "description":"Transaction Status\n\nAllowed values:\n- Disable\n- Enabled",
            "type":"string",
            "example":"Enabled"
        },
        "TransactionDescription":{
            "description":"Transaction Description",
            "type":"string",
            "example":"Using Mechanize library to parse a web site and verify how long it takes to load and if it returns a search criteria"
        },
        "TransactionText":{
            "description":"Content of Transaction",
            "type":"string",
            "example":""
        },
        "TransactionStatusID":{
            "description":"The transaction status ID. Either <b>0</b> (disabled) or <b>1</b> (enabled).",
            "type":"integer",
            "example":"1"
        },
        "MetricTypeID":{
            "description":"Metric Type associated to Transaction",
            "type":"integer",
            "example":"90"
        },
        "MetricTypeName":{
            "description":"Metric Type Name",
            "type":"string",
            "example":"Response Times"
        }
    },
    "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