Metrics

The Metrics Service provides access to metrics data defined and gathered by the system.

Get Metric Metadata

Retrieve the available query parameters and field definitions for a metric.

SecurityJWT
Request
path Parameters
metricPath
required
string
Responses
200

Success

404

Not found

500

Internal Server Error

get/cw/metrics/getMetricMetadata/{metricPath}
Request samples 
Response samples 
{
  • "metricPath": "IR/Billing/Items",
  • "parameterDefs": [
    ],
  • "fieldDefs": [
    ]
}
List Metrics
Get a list of available metric paths


SecurityJWT 
Responses 
200
Success


500
Internal Server Error


get/cw/metrics/listMetrics
Request samples 
Response samples 
{
  • "rows": [
    ],
  • "totalCount": 0
}
Get Metric Observations
Gets observations for the given criteria. Rows are of type APIObservationRow


SecurityJWT 
Request 
path Parameters
metricPath
required
string
 
Request Body schema: 
required
Array of objects (ParameterValue) 
List of Parameters defining the criteria for an operation


 
Responses 
200
Success


500
Internal Server Error


post/cw/metrics/getMetricObservations/{metricPath}
Request samples 
{
  • "parameterList": [
    ]
}
Response samples 
{
  • "queryPath": "Business Units",
  • "parameterDefs": [
    ],
  • "rowType": "APITransaction",
  • "populatedFields": [
    ],
  • "sortableFields": [
    ]
}
➔ Next to Online Payments