---
title: "List benchmarks summaries"
method: GET
path: "/compliance/api/v1/benchmarks/summary"
tags: ["compliance"]
---

# List benchmarks summaries

`GET /compliance/api/v1/benchmarks/summary`

## Request

- Base URL: `https://api.opengovernance.io`
- URL: `https://api.opengovernance.io/compliance/api/v1/benchmarks/summary`
- Auth: API key in header `Authorization`

Retrieving a summary of all benchmarks and their associated checks and results within a specified time interval.

## Query parameters

- `integrationId` string[]
- `connectionGroup` string[]
- `resourceCollection` string[]
- `connector` string[]
- `tag` string[]
- `timeAt` integer
- `topAccountCount` integer

## Response `200`

OK

- GithubComOpengovernOpengovernancePkgComplianceApiListBenchmarksSummaryResponse
  - `benchmarkSummary` GithubComOpengovernOpengovernancePkgComplianceApiBenchmarkEvaluationSummary[]
    - `autoAssign` boolean: Whether the benchmark is auto assigned or not
    - `category` string: Benchmark category
    - `checks` TypesSeverityResult
      - `criticalCount` integer
      - `highCount` integer
      - `lowCount` integer
      - `mediumCount` integer
      - `noneCount` integer
    - `children` string[]: Benchmark children
    - `complianceStatusSummary` GithubComOpengovernOpengovernancePkgComplianceApiComplianceStatusSummary
      - `failed` integer
      - `passed` integer
    - `connectionsStatus` GithubComOpengovernOpengovernancePkgComplianceApiBenchmarkStatusResult
      - `passed` integer
      - `total` integer
    - `controls` string[]: Benchmark controls
    - `controlsSeverityStatus` GithubComOpengovernOpengovernancePkgComplianceApiBenchmarkControlsSeverityStatus
      - `critical` GithubComOpengovernOpengovernancePkgComplianceApiBenchmarkStatusResult
        - `passed` integer
        - `total` integer
      - `high` GithubComOpengovernOpengovernancePkgComplianceApiBenchmarkStatusResult
        - `passed` integer
        - `total` integer
      - `low` GithubComOpengovernOpengovernancePkgComplianceApiBenchmarkStatusResult
        - `passed` integer
        - `total` integer
      - `medium` GithubComOpengovernOpengovernancePkgComplianceApiBenchmarkStatusResult
        - `passed` integer
        - `total` integer
      - `none` GithubComOpengovernOpengovernancePkgComplianceApiBenchmarkStatusResult
        - `passed` integer
        - `total` integer
      - `total` GithubComOpengovernOpengovernancePkgComplianceApiBenchmarkStatusResult
        - `passed` integer
        - `total` integer
    - `costImpact` number
    - `createdAt` string: Benchmark creation date
    - `description` string: Benchmark description
    - `documentURI` string: Benchmark document URI
    - `evaluatedAt` string
    - `id` string: Benchmark ID
    - `integrationTypes` string[]: Benchmark connectors
    - `lastJobStatus` string
    - `logoURI` string: Benchmark logo URI
    - `referenceCode` string: Benchmark display code
    - `resourcesSeverityStatus` GithubComOpengovernOpengovernancePkgComplianceApiBenchmarkResourcesSeverityStatus
      - `critical` GithubComOpengovernOpengovernancePkgComplianceApiBenchmarkStatusResult
        - `passed` integer
        - `total` integer
      - `high` GithubComOpengovernOpengovernancePkgComplianceApiBenchmarkStatusResult
        - `passed` integer
        - `total` integer
      - `low` GithubComOpengovernOpengovernancePkgComplianceApiBenchmarkStatusResult
        - `passed` integer
        - `total` integer
      - `medium` GithubComOpengovernOpengovernancePkgComplianceApiBenchmarkStatusResult
        - `passed` integer
        - `total` integer
      - `none` GithubComOpengovernOpengovernancePkgComplianceApiBenchmarkStatusResult
        - `passed` integer
        - `total` integer
      - `total` GithubComOpengovernOpengovernancePkgComplianceApiBenchmarkStatusResult
        - `passed` integer
        - `total` integer
    - `tags` object: Benchmark tags
    - `title` string: Benchmark title
    - `topConnections` GithubComOpengovernOpengovernancePkgComplianceApiTopFieldRecord[]
      - `control` GithubComOpengovernOpengovernancePkgComplianceApiControl
        - `cliRemediation` string
        - `connector` string[]
        - `createdAt` string
        - `description` string
        - `documentURI` string
        - `enabled` boolean
        - `explanation` string
        - `guardrailRemediation` string
        - `id` string
        - `managed` boolean
        - `manualRemediation` string
        - `manualVerification` boolean
        - `nonComplianceCost` string
        - `programmaticRemediation` string
        - `query` GithubComOpengovernOpengovernancePkgComplianceApiQuery
          - `Global` boolean
          - `createdAt` string
          - `engine` string
          - `id` string
          - `integrationType` string[]
          - `listOfTables` string[]
          - `parameters` GithubComOpengovernOpengovernancePkgComplianceApiQueryParameter[]
            - `key` string
            - `required` boolean
          - `primaryTable` string
          - `queryToExecute` string
          - `updatedAt` string
        - `severity` 'none' | 'low' | 'medium' | 'high' | 'critical'
        - `tags` object
        - `title` string
        - `updatedAt` string
        - `usefulExample` string
      - `controlCount` integer
      - `controlTotalCount` integer
      - `count` integer
      - `field` string
      - `integration` GithubComOpengovernOpengovernanceServicesIntegrationApiModelsIntegration
        - `annotations` object
        - `credential_id` string
        - `integration_id` string
        - `integration_type` string
        - `labels` object
        - `last_check` string
        - `name` string
        - `provider_id` string
        - `state` 'ACTIVE' | 'INACTIVE' | 'ARCHIVED'
      - `resourceCount` integer
      - `resourceTotalCount` integer
      - `resourceType` GithubComOpengovernOpengovernancePkgInventoryApiResourceType
        - `attributes` string[]: List supported steampipe Attributes (columns) for this resource type - Metadata (GET only)
        - `compliance` string[]: List of Compliance that support this Resource Type - Metadata (GET only)
        - `compliance_count` integer: Number of Compliance that use this Resource Type - Metadata
        - `count` integer: Number of Resources of this Resource Type - Metric
        - `integration_type` string: Cloud Provider
        - `logo_uri` string: Logo URI
        - `old_count` integer: Number of Resources of this Resource Type in the past - Metric
        - `resource_name` string: Resource Name
        - `resource_type` string: Resource Type
        - `service_name` string: Service Name
        - `tags` string[]: Tags
      - `service` string
      - `totalCount` integer
    - `tracksDriftEvents` boolean: Whether the benchmark tracks drift events or not
    - `updatedAt` string: Benchmark last update date
  - `totalChecks` TypesSeverityResult
    - `criticalCount` integer
    - `highCount` integer
    - `lowCount` integer
    - `mediumCount` integer
    - `noneCount` integer
  - `totalComplianceStatusSummary` GithubComOpengovernOpengovernancePkgComplianceApiComplianceStatusSummary
    - `failed` integer
    - `passed` integer

---

[API](https://skmtc.dev/opengovern/apis/opengovernance-service-api.md) - [All operations](https://skmtc.dev/opengovern/apis/opengovernance-service-api/llms.txt) - [OpenAPI document](https://skmtc.dev/opengovern/apis/opengovernance-service-api/revisions/ab05295c4094?raw)