Understanding Metric Data

The Metric endpoint returns the measured results for each of the Cloud Manager quality gates: Code Quality, Security, Performance, and Experience Audit. Each metric is represented with a JSON object containing the severity, the expected value, the actual value, the result, the comparator used to generate the result, and the metric name.

For example, if you look at the code quality metrics, you will see an object like this:

Copy
{
    "id": "7776",
    "severity": "important",
    "passed": true,
    "override": false,
    "actualValue": "50.4",
    "expectedValue": "50",
    "comparator": "GTE",
    "kpi": "coverage"
}
Copied to your clipboard
{
    "id": "7776",
    "severity": "important",
    "passed": true,
    "override": false,
    "actualValue": "50.4",
    "expectedValue": "50",
    "comparator": "GTE",
    "kpi": "coverage"
}

Here, we can see that this is the coverage metric, the expected value is 50, the actual value is 50.4, to pass the actual value must be greater than or equal to (GTE) the expected value, that the metric passed.

The kpi value is a technical value which will generally need to be translated into a user-facing value. The reference tables below provide mappings between the technical name in the API response and the names/definitions in the documentation for each of the quality gates.

Code Quality

Security Testing

Performance Testing

Experience Audit

Last updated 10/21/2021

Was this helpful?

Yes

No