Get component metric series

curl --request GET \
  --url https://api.qlty.sh/gh/{ownerKeyOrId}/projects/{projectKeyOrId}/components/{componentIdOrName}/metrics/series \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "metric": {
        "key": "CMPLX",
        "name": "Cognitive Complexity",
        "category": "maintainability",
        "inverted": true,
        "valueType": "number",
        "description": "Measures how hard the code is to understand"
      },
      "dimensions": {},
      "points": [
        {
          "timestamp": "2026-01-11T23:59:59Z",
          "value": 42
        }
      ]
    }
  ],
  "meta": {
    "from": "2025-12-01T00:00:00Z",
    "to": "2026-06-01T00:00:00Z",
    "interval": "week"
  }
}

Metrics

Get component metric series

Retrieve each metric’s history for a specific Component on the Project’s default branch as a time series over the requested window. Returns one series per metric — covering maintainability, reliability, security, size, coverage, and quality indicators — each with the metric’s descriptor and one value per interval; narrow the result with the metric and category query parameters. Available as JSON, newline-delimited JSON (application/x-ndjson), or CSV (text/csv) via the Accept header. Buckets are UTC-aligned and labeled with the inclusive end of each interval; a bucket with no measurement carries the most recent prior value forward, and the final bucket (the one containing to) may be labeled later than to — including the future for an interval still in progress — with its value reflecting only measurements within the window.

GET

/

gh

/

{ownerKeyOrId}

/

projects

/

{projectKeyOrId}

/

components

/

{componentIdOrName}

/

metrics

/

series

Get component metric series

curl --request GET \
  --url https://api.qlty.sh/gh/{ownerKeyOrId}/projects/{projectKeyOrId}/components/{componentIdOrName}/metrics/series \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "metric": {
        "key": "CMPLX",
        "name": "Cognitive Complexity",
        "category": "maintainability",
        "inverted": true,
        "valueType": "number",
        "description": "Measures how hard the code is to understand"
      },
      "dimensions": {},
      "points": [
        {
          "timestamp": "2026-01-11T23:59:59Z",
          "value": 42
        }
      ]
    }
  ],
  "meta": {
    "from": "2025-12-01T00:00:00Z",
    "to": "2026-06-01T00:00:00Z",
    "interval": "week"
  }
}

Authorizations

Authorization

string

header

required

Generate an API token at https://qlty.sh/user/settings/tokens

Path Parameters

ownerKeyOrId

string

required

Repository owner name (login) or workspace ID

Minimum string length: 3

Example:

"acme-corp"

projectKeyOrId

string

required

Repository name or project ID

Minimum string length: 3

Example:

"my-repo"

componentIdOrName

string

required

Component ID or name

Minimum string length: 1

Example:

"backend-api"

Query Parameters

from

string<date-time>

Window start (RFC 3339 date or date-time, inclusive). Defaults to six months before to.

Example:

"2026-01-01"

to

string<date-time>

Window end (RFC 3339 date or date-time, inclusive). Defaults to the current time and is clamped to it.

Example:

"2026-06-01"

interval

enum<string>

default:week

Bucket size; buckets are UTC-aligned and weeks start Monday

Available options:

day,

week,

month

metric

Filter by metric key

Available options:

CMPLX,

DUP,

MNT,

SEC,

SIZE,

ISS,

SECI,

TDR,

FILES,

LOC,

COV,

LCOV

category

Filter by metric category

Available options:

maintainability,

reliability,

security,

size,

coverage,

quality

Response

Retrieve metric time series for a component

data

object[]

required

Show child attributes

meta

object

required

Show child attributes

Get component metrics Get project metrics