Skip to content
Speccy

The metrics of SDD §8.9, per profile (REQ-092). Maintainers and admins.

GET
/insights
curl --request GET \
  --url https://example.com/api/v1/insights

Responses

Section titled “ Responses ”

200

Section titled “200”

The metrics.

Media typeapplication/json
object
profiles
required
Array<object>
object
key
required
string
name
required
string
bundles
required
integer
standalone
required
integer
build_ready
required

Bundles whose current verdict is Build Ready.

integer
runs_to_build_ready
required

The median number of review runs before the first Build Ready verdict. 0 with no data.

number
hours_to_build_ready
required

The median hours from the first review to the first Build Ready verdict.

number
hours_to_approval
required

The median hours from in review to approved.

number
top_failing
required
Array<object>
object
check_slug
required
string
count
required
integer
breach_rate
required

The share of verified trace IDs of this profile that came back breached or missing. 0 with no verification runs.

number
verified_trace_ids
required

The trace IDs that the verification runs of this profile verified, which the breach rate divides by.

integer
false_ready_rate
required

The share of Build Ready handoffs of this profile that came back blocked (REQ-137). 0 with no handoffs.

number
blocked_sections
required

The sections that blocked reports point at, most frequent first.

Array<object>
object
section
required
string
count
required
integer
waiver_rate
required
Array<object>
object
check_slug
required
string
waived
required
integer
requested
required
integer
Examplegenerated
{
  "profiles": [
    {
      "key": "example",
      "name": "example",
      "bundles": 1,
      "standalone": 1,
      "build_ready": 1,
      "runs_to_build_ready": 1,
      "hours_to_build_ready": 1,
      "hours_to_approval": 1,
      "top_failing": [
        {
          "check_slug": "example",
          "count": 1
        }
      ],
      "breach_rate": 1,
      "verified_trace_ids": 1,
      "false_ready_rate": 1,
      "blocked_sections": [
        {
          "section": "example",
          "count": 1
        }
      ],
      "waiver_rate": [
        {
          "check_slug": "example",
          "waived": 1,
          "requested": 1
        }
      ]
    }
  ]
}

default

Section titled “default”

An error.

Media typeapplication/problem+json

RFC 9457 problem details with a stable code.

object
type
required
string
title
required
string
status
required
integer
detail
string
instance
string
code
required

A stable machine-readable error code.

string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "code": "example"
}