GitHub: List code scanning analyses for a repository

← Code scanning operations · Get started

Operation github.code_scanning_list_recent_analyses

Provider route: GET /repos/{owner}/{repo}/code-scanning/analyses. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/github with npm, or alter-sdk-github with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { GitHubIntegration } from "@alter-ai/github";

async function execute(input: Parameters<GitHubIntegration["codeScanning"]["codeScanningListRecentAnalyses"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new GitHubIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.codeScanning.codeScanningListRecentAnalyses(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_github import GitHubIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = GitHubIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.code_scanning.code_scanning_list_recent_analyses(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.owner	string	Required within parent
path.repo	string	Required within parent
query	object	Optional	Additional keys: not allowed
query.tool_name	string	Optional	The name of the tool used to generate the code scanning analysis.
query.tool_guid	Model	Optional	Expand Get a code scanning alert — response body — tool guid
query.page	integer	Optional	Default: 1
query.per_page	integer	Optional	Default: 30
query.pr	integer	Optional
query.ref	string	Optional	The Git reference, formatted as `refs/pull/<number>/merge`, `refs/pull/<number>/head`, `refs/heads/<branch name>` or simply `<branch name>`.
query.sarif_id	string	Optional	An identifier for the upload.
query.direction	string	Optional	Default: desc One of: asc, desc
query.sort	string	Optional	Default: created One of: created

Referenced models: Get a code scanning alert — response body — tool guid

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	array	Root
$[]	Model	Each item	Expand Get a code scanning analysis for a repository — response body

Referenced models: Get a code scanning analysis for a repository — response body

Schemas

Get a code scanning analysis for a repository — response body

Field	Type	Presence	Description and constraints
$	object	Root
analysis_key	string	Required within parent	Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.
category	string	Optional	Identifies the configuration under which the analysis was executed. Used to distinguish between multiple analyses for the same tool and commit, but performed on different languages or different parts of the code.
commit_sha	string	Required within parent	The SHA of the commit to which the analysis you are uploading relates. Maximum length: 64 Minimum length: 40 Pattern: ^([0-9a-fA-F]{40}(?:[0-9a-fA-F]{24})?)$
created_at	string	Required within parent	The time that the analysis was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Format: date-time Read only: true
deletable	boolean	Required within parent
environment	string	Required within parent	Identifies the variable values associated with the environment in which this analysis was performed.
error	string	Required within parent
id	JSON	Required within parent
id (anyOf 1)	integer	Alternative	Unique identifier for this analysis.
id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
ref	string	Required within parent	The Git reference, formatted as `refs/pull/<number>/merge`, `refs/pull/<number>/head`, `refs/heads/<branch name>` or simply `<branch name>`.
results_count	JSON	Required within parent
results_count (anyOf 1)	integer	Alternative	The total number of results in the analysis.
results_count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
rules_count	JSON	Required within parent
rules_count (anyOf 1)	integer	Alternative	The total number of rules used in the analysis.
rules_count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
sarif_id	string	Required within parent	An identifier for the upload.
tool	Model	Required within parent	Expand Get a code scanning alert — response body — tool
url	string	Required within parent	The REST API URL of the analysis resource. Format: uri Read only: true
warning	string	Required within parent	Warning generated when processing the analysis

Referenced models: Get a code scanning alert — response body — tool

Get a code scanning alert — response body — tool guid

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	string	Alternative	The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data.
$ (anyOf 2)	null	Alternative

Get a code scanning alert — response body — tool

Field	Type	Presence	Description and constraints
$	object	Root
guid	Model	Optional	Expand Get a code scanning alert — response body — tool guid
name	string	Optional	The name of the tool used to generate the code scanning analysis.
version	Model	Optional	Expand Get a code scanning alert — response body — tool version

Referenced models: Get a code scanning alert — response body — tool guid, Get a code scanning alert — response body — tool version

Get a code scanning alert — response body — tool version

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	string	Alternative	The version of the tool used to generate the code scanning analysis.
$ (anyOf 2)	null	Alternative

Policy, approvals and errors

SDK function policy ID: github.code_scanning_list_recent_analyses. Catalog operation: code-scanning/list-recent-analyses. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Pinned headers: {"X-GitHub-Api-Version": "2026-03-10", "User-Agent": "Alter", "Accept": "application/vnd.github+json"}

Official provider source