AIaikido

List code quality findings for a pull request

Returns a list of code quality findings for a specific pull request. Only the findings from the latest scan are returned, excluding any suppressed findings.

get/code-quality/findings

Request

  • Base URL
    https://app.aikido.dev/api/public/v1
  • URL
    https://app.aikido.dev/api/public/v1/code-quality/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

pr_numberstring required

The pull request number

Response

A list of code quality findings for the specified pull request

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.",
      "reasoning": "The identifier 'x' carries no information about the value it holds, which makes the surrounding logic harder to follow.",
      "file": "example.py",
      "start_line": 16,
      "end_line": 16,
      "language": "PY",
      "external_comment_id": "760761091",
      "scan_id": 28610,
      "timestamp": 1772204942
    }
  ]
}

Changes

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