v1

latestOpenAPI 3.0.02026-07-141,4077,1665.2 MB

Scorecards

List all scores

Returns a list of scorecard scores for each aggregation type, with score breakdowns.

get/api/v2/scorecard/scores/{aggregation}

Path parameters

aggregation'by-entity' | 'by-rule' | 'by-scorecard' | 'by-team' | 'by-kind' required

Dimension to group scores by.

Example:by-entity

The type of scores being requested.

Query parameters

filter[rule][id]string

Filter scores by rule ID(s), comma-separated.

filter[rule][name]string

Filter scores by rule name.

filter[rule][level]string

Filter scores by rule level(s), comma-separated.

filter[rule][scorecard_id]string

Filter scores by scorecard ID(s), comma-separated.

filter[rule][is_custom]boolean

Filter scores to show only custom rules.

filter[rule][is_enabled]boolean

Filter scores to show only enabled rules.

sortstring

Sort scores by field. Use a hyphen prefix for descending order. Options: score, numerator, denominator, total_pass, total_fail, total_skip, total_no_data.

page[offset]integer

Offset for pagination.

page[limit]integer

Number of scores to return. Max is 1000.

Response

Example response

{
  "data": [
    {
      "attributes": {
        "aggregation": "by-entity"
      },
      "type": "score"
    }
  ],
  "links": {
    "next": "/api/v2/scorecard/rules?page%5Blimit%5D=2&page%5Boffset%5D=2&page%5Bsize%5D=2"
  }
}