quality

Returns backend-managed thresholds and benchmark values used for interpretation and visualization of Code Health metrics.

get/api/projects/{project-id}/quality/code-health/benchmarks

Request

  • Base URL: https://codescene.io (the document declares no server; this is the origin it was published from)
  • URL: https://codescene.io/api/projects/{project-id}/quality/code-health/benchmarks
  • Auth: none declared

Path parameters

project-idinteger required

Response

metricstring required

Name of the metric these benchmarks apply to.

Example response

{
  "benchmarks": [
    {
      "id": "industry-average",
      "label": "Industry Average",
      "type": "benchmark",
      "value": 5.15
    }
  ],
  "metric": "codeHealth",
  "scale": {
    "min": 1,
    "max": 10
  }
}

Changes

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