quality

Returns estimated engineering outcome intervals for a Code Health change.

get/api/quality/engineering-outcomes

Request

  • Base URL: https://codescene.io (the document declares no server; this is the origin it was published from)
  • URL: https://codescene.io/api/quality/engineering-outcomes
  • Auth: none declared

Query parameters

baselinenumber required
Example:6.2

Baseline Code Health score between 1.0 and 10.0.

targetnumber required
Example:6.2

Target Code Health score between 1.0 and 10.0.

initialUnplannedWorkPctnumber

Initial unplanned work percentage to use for the derived combined productivity impact estimate. When omitted, the default depends on baseline Code Health: 50 below 4.0, 30 below 7.0, otherwise 10.

Response

baselineCodeHealthnumber required

Baseline Code Health score used for the estimate.

targetCodeHealthnumber required

Target Code Health score used for the estimate.

unit'percent' required

Unit of the outcome interval bounds. Every bound is a relative change from the baseline.

confidenceLevelinteger required

Confidence level of the outcome intervals, in percent.

summarystring required

Human-readable summary of the estimate, intended to be shown as-is by every client.

Example response

{
  "baselineCodeHealth": 6.2,
  "targetCodeHealth": 8.1,
  "unit": "percent",
  "confidenceLevel": 90,
  "assumptions": {
    "initialUnplannedWorkPct": 30,
    "initialUnplannedWorkPctSource": "default"
  },
  "summary": "Improving Code Health from 6.2 to 8.1 is associated with 7% to 22% fewer defects and 11% to 23% less development time for future changes to this code. Combined, that is 18% to 37% higher productivity, assuming 30% of current work is unplanned. Ranges are 90% confidence intervals.",
  "outcomes": {
    "defects": {
      "lower": -21.85,
      "upper": -6.69,
      "direction": "decrease",
      "interpretation": "7% to 22% fewer defects"
    },
    "developmentTime": {
      "lower": -22.79,
      "upper": -11.46,
      "direction": "decrease",
      "interpretation": "11% to 23% less development time"
    },
    "combinedProductivityImpact": {
      "lower": 18.32,
      "upper": 37.31,
      "direction": "increase",
      "interpretation": "18% to 37% higher productivity"
    }
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.