Sign in

v1

latestOpenAPI 3.1.02026-07-261690320.7 KB

List PR Checks

Returns PR checks

get/report/ciScans

Query parameters

pageinteger

Pagination parameter, starts at 0.

per_pageinteger

max 50

Amount of items returned

filter_code_repo_idinteger

ID of a repository to filter the PR checks

filter_gate_status'all' | 'timed_out' | 'unknown' | 'passed' | 'failed' | 'bypassed' | 'pending'

enum to filter the PR checks for a specific gate_status. The default value is 'all'.

searchstring

string to filter the PR checks based on this search term

Response

A list PR checks

scan_idinteger
gate_statusinteger
new_issues_countinteger
solved_issues_countinteger
started_atinteger
related_commit_shastring
code_repo_idinteger
code_repo_nameinteger
pull_request_titlestring
pull_request_urlstring
branch_namestring
is_release_gatingboolean

Example response

[
  {
    "scan_id": 1,
    "gate_status": "failed",
    "new_issues_count": 2,
    "solved_issues_count": 5,
    "started_at": 1751595600,
    "related_commit_sha": "nvr9onnag1veuupnever9onnal3tud0wn",
    "code_repo_id": 1,
    "code_repo_name": "demo-repo",
    "pull_request_title": "Demo PR Check",
    "pull_request_url": "https://github.com/AikidoDemo/demo-repo/pull/12345",
    "branch_name": "demo-ci-scan",
    "is_release_gating": false
  }
]