AIaikido

List code quality findings for a repository

Returns a paginated list of code quality findings for a repository. Findings represent repository state across full-repository scans rather than a snapshot of one scan. Use the header X-Has-Next-Page for pagination.

get/code-quality/repo-findings

Request

  • Base URL
    https://app.aikido.dev/api/public/v1
  • URL
    https://app.aikido.dev/api/public/v1/code-quality/repo-findings
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://app.aikido.io/api/oauth/token scopes: code_quality:read

Query parameters

code_repo_idinteger required

The ID of the repository

filter_state'open' | 'ignored' | 'closed'

Only return findings in this state

pageinteger

Pagination parameter, starts at 0.

per_pageinteger

Amount of items returned

Response

A list of code quality findings for the specified repository

Example response

{
  "findings": [
    {
      "id": 8124,
      "rule_id": "AIK_AI_descriptive_names",
      "description": "Variable 'x' is a non-descriptive single-letter name; use a descriptive name reflecting its purpose.",
      "severity": "medium",
      "severity_score": 60,
      "file": "example.py",
      "start_line": 16,
      "end_line": 16,
      "start_column": 5,
      "end_column": 6,
      "language": "PY",
      "timestamp": 1772204942,
      "state": "open"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.