Get Project Metrics

curl /gh/acmeco/projects/awesome-project/metrics \
     -H "Authorization: Bearer <token>"

{
  "data": [
    {
      "key": "complexity",
      "name": "Cognitive Complexity",
      "category": "maintainability",
      "value": 15.7,
      "inverted": true,
      "description": "Measures the cognitive load required to understand the code"
    },
    {
      "key": "coverage",
      "name": "Test Coverage",
      "category": "reliability",
      "value": 87.5,
      "inverted": false,
      "description": "Percentage of code covered by tests"
    },
    {
      "key": "duplication",
      "name": "Code Duplication",
      "category": "maintainability",
      "value": 3.2,
      "inverted": true,
      "description": "Percentage of duplicated code"
    }
  ]
}

Retrieve the latest values of all metrics for a Project's default branch

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

ownerKeyOrIdstringRequired

The key or ID of the Workspace that owns the Project

projectKeyOrIdstringRequired

The key or ID of the Project to retrieve metrics for

Response

This endpoint returns an object.

datalist of objects

List of Metric items returned in the response

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

429

Too Many Requests Error