records

Assess template heatmap quality

Return structured quality findings and deterministic scoring policy v1.

GET

/api/records/{company_name}/templates/{template_id}/diagnostics/quality-check

curl --request GET \
  --url '/api/records/{company_name}/templates/{template_id}/diagnostics/quality-check?lang=en&include_review_snapshot=false' \
  --header 'Authorization: Bearer <token>'

{
  "components": {
    "breakdown": [
      {
        "actual_problems": 123,
        "applicable_rules": [
          "CAUSES_MORE_THAN_SYMPTOMS"
        ],
        "fired_rules": [
          "CAUSES_MORE_THAN_SYMPTOMS"
        ],
        "kind": "causes",
        "possible_problems": 123,
        "uid": "<string>",
        "weighted_actual": 123,
        "weighted_possible": 123
      }
    ],
    "fired_global_rules": [
      "CAUSES_MORE_THAN_SYMPTOMS"
    ],
    "global_score": 123,
    "global_weight": 0.3333333333333333,
    "impact_weights": {},
    "item_score": 123,
    "item_weight": 0.6666666666666666,
    "possible_global_problems": 3
  },
  "coverage": {
    "causes": 123,
    "complete": true,
    "declared_cells": 123,
    "negative_wording_evaluated_symptom_ids": [
      "<string>"
    ],
    "negative_wording_supported": true,
    "symptoms": 123,
    "unknown_cells": 123,
    "valid_cells": 123
  },
  "findings": [
    {
      "actions": [
        {
          "cause_ids": [
            "<string>"
          ],
          "symptom_ids": [
            "<string>"
          ],
          "type": "filter"
        }
      ],
      "cause_ids": [
        "<string>"
      ],
      "id": "CAUSES_MORE_THAN_SYMPTOMS",
      "impact": "high",
      "metadata": {
        "count": 123,
        "locale": "<string>",
        "ratio": 123,
        "threshold": 123,
        "total": 123
      },
      "pairs": [
        {
          "items": [
            {
              "kind": "causes",
              "uid": "<string>"
            }
          ],
          "similarity": 123,
          "support": 123
        }
      ],
      "symptom_ids": [
        "<string>"
      ]

Score = 2/3 item score + 1/3 global score. Item penalties use high=1, medium=.75, low=.5; each item/rule counts once. Global rules count equally. See docs/heatmap-quality-check.md for thresholds, missing-data semantics, score denominators and action targets. No mutation or translation occurs.

Authorizations

Authorizationstringheaderrequired

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

Path Parameters

template_idstringrequired

Required string length: 24 - 24

Pattern: ^[0-9a-f]{24}$

Example: 5eb7cf5a86d9755df3a6c593

company_namestringrequired

Query Parameters

langenum<string>querydefault:en

Name comparison locale. Negative wording always checks available English translations, independent of this locale, without fallback.

Available options: en, de, fr, es, it, pt, nl, pl, cs, da, sv, fi, nb, et, lt, lv, sk, sl, bg, ru, uk, el, tr, hu, ja, ko, zh, id

include_review_snapshotbooleanquerydefault:false

Include the raw heatmap assessed by this request for a subsequent holistic review.

Response

Successful Response

componentsobjectrequired

Show child attributes

coverageobjectrequired

Show child attributes

findingsobject[]required

Show child attributes

localestringrequired

percentagenumberrequired

Unrounded score multiplied by 100.

Required range: 0 <= x <= 100

review_snapshotobject | null

Present only when include_review_snapshot=true. Raw inputs from the exact snapshot assessed by policy v1; non-finite numbers are represented as NaN/Infinity/-Infinity strings.

Show child attributes

schema_versionintegerdefault:1required

scorenumberrequired

Policy v1: 2/3 item_score + 1/3 global_score, bounded to [0,1]. Read coverage alongside this score.

Required range: 0 <= x <= 1

scoring_versionintegerdefault:1required

verdictenum<string>required

Available options: good, warning, poor, insufficient_data