Skip to main content
GET
/
v1
/
compliance
/
product
/
summary
Get lightweight product compliance summary
curl --request GET \
  --url https://api.app.chainloop.dev/v1/compliance/product/summary \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.app.chainloop.dev/v1/compliance/product/summary"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.app.chainloop.dev/v1/compliance/product/summary', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.app.chainloop.dev/v1/compliance/product/summary",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.app.chainloop.dev/v1/compliance/product/summary"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.app.chainloop.dev/v1/compliance/product/summary")
  .header("Authorization", "Bearer <token>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.app.chainloop.dev/v1/compliance/product/summary")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "frameworks": [
    {
      "framework_name": "framework_name",
      "requirements": [
        {
          "requirement_version_id": "requirement_version_id",
          "overall_status": "overall_status",
          "description": "description",
          "display_name": "display_name",
          "requirement_id": "requirement_id",
          "project_breakdown": {
            "expired": 9,
            "pending": 7,
            "failing": 5,
            "not_applicable": 1,
            "passing": 5,
            "total_applicable": 6,
            "partial": 2,
            "exempted": 3
          },
          "automation_level": "unspecified",
          "framework_name": "framework_name",
          "has_manual_evidence_needs_review": true,
          "requirement_revision": 0,
          "scope": "UNSPECIFIED",
          "override_status": "override_status",
          "name": "name",
          "framework_display_name": "framework_display_name",
          "not_applicable": true,
          "has_override": true,
          "has_pending_override": true
        },
        {
          "requirement_version_id": "requirement_version_id",
          "overall_status": "overall_status",
          "description": "description",
          "display_name": "display_name",
          "requirement_id": "requirement_id",
          "project_breakdown": {
            "expired": 9,
            "pending": 7,
            "failing": 5,
            "not_applicable": 1,
            "passing": 5,
            "total_applicable": 6,
            "partial": 2,
            "exempted": 3
          },
          "automation_level": "unspecified",
          "framework_name": "framework_name",
          "has_manual_evidence_needs_review": true,
          "requirement_revision": 0,
          "scope": "UNSPECIFIED",
          "override_status": "override_status",
          "name": "name",
          "framework_display_name": "framework_display_name",
          "not_applicable": true,
          "has_override": true,
          "has_pending_override": true
        }
      ],
      "framework_id": "framework_id",
      "framework_display_name": "framework_display_name",
      "metrics": {
        "pending_requirements": 5,
        "passing_requirements": 6,
        "compliance_percentage": 2.302136,
        "inactive_requirements": 7,
        "failing_requirements": 1,
        "partial_requirements": 5,
        "total_requirements": 0
      }
    },
    {
      "framework_name": "framework_name",
      "requirements": [
        {
          "requirement_version_id": "requirement_version_id",
          "overall_status": "overall_status",
          "description": "description",
          "display_name": "display_name",
          "requirement_id": "requirement_id",
          "project_breakdown": {
            "expired": 9,
            "pending": 7,
            "failing": 5,
            "not_applicable": 1,
            "passing": 5,
            "total_applicable": 6,
            "partial": 2,
            "exempted": 3
          },
          "automation_level": "unspecified",
          "framework_name": "framework_name",
          "has_manual_evidence_needs_review": true,
          "requirement_revision": 0,
          "scope": "UNSPECIFIED",
          "override_status": "override_status",
          "name": "name",
          "framework_display_name": "framework_display_name",
          "not_applicable": true,
          "has_override": true,
          "has_pending_override": true
        },
        {
          "requirement_version_id": "requirement_version_id",
          "overall_status": "overall_status",
          "description": "description",
          "display_name": "display_name",
          "requirement_id": "requirement_id",
          "project_breakdown": {
            "expired": 9,
            "pending": 7,
            "failing": 5,
            "not_applicable": 1,
            "passing": 5,
            "total_applicable": 6,
            "partial": 2,
            "exempted": 3
          },
          "automation_level": "unspecified",
          "framework_name": "framework_name",
          "has_manual_evidence_needs_review": true,
          "requirement_revision": 0,
          "scope": "UNSPECIFIED",
          "override_status": "override_status",
          "name": "name",
          "framework_display_name": "framework_display_name",
          "not_applicable": true,
          "has_override": true,
          "has_pending_override": true
        }
      ],
      "framework_id": "framework_id",
      "framework_display_name": "framework_display_name",
      "metrics": {
        "pending_requirements": 5,
        "passing_requirements": 6,
        "compliance_percentage": 2.302136,
        "inactive_requirements": 7,
        "failing_requirements": 1,
        "partial_requirements": 5,
        "total_requirements": 0
      }
    }
  ]
}
{
  "code": 0,
  "details": [
    "details",
    "details"
  ],
  "message": "message"
}
{
  "code": 6,
  "details": [
    "details",
    "details"
  ],
  "message": "message"
}
{
  "code": 1,
  "details": [
    "details",
    "details"
  ],
  "message": "message"
}
{
  "code": 5,
  "details": [
    "details",
    "details"
  ],
  "message": "message"
}
{
  "code": 5,
  "details": [
    {
      "@type": "@type"
    },
    {
      "@type": "@type"
    }
  ],
  "message": "message"
}

Authorizations

​
Authorization
string
header
required

Bearer token for authentication

Query Parameters

​
product_version_id
string

The product version ID to summarize

​
framework_ids
string[]

Optional framework filter. If empty, returns all frameworks for the product version.

​
bypass_cache
boolean

When true, skip the compliance cache and recompute from source. Intended for testing.

Response

A successful response.

Lightweight product compliance summary: per-requirement aggregated status and pre-computed flags, without policy payloads, manual evidence, override details or per-project breakdowns.

​
frameworks
Per-framework summaries · object[]