Check

Analyzer checks within an analysis run, including issue occurrences and metrics.

Each analysis run contains one or more checks (one per analyzer). Use this to get the issues found by a specific analyzer in a run.

Objects

A single analyzer check as part of an analysis run.

Field	Type	Description
id	ID!	The ID of the object.
sequence	Int!	Sequence number of the check in the analysis run it belongs to.
status	CheckStatus!	The current status of the check.
analyzer	Analyzer!	The analyzer related to the check.
createdAt	DateTime!	Time when the check was created.
updatedAt	DateTime!	Time when the check was last modified.
finishedAt	DateTime	Time when the check finished.
summary	CheckSummary!	Summary of the check.
issues	AnalysisIssueConnection!	Issues found in the check.
source	AnalysisIssueSource	Filter by issue source.
category	IssueCategory	Filter by issue category.
severity	IssueSeverity	Filter by issue severity.
q	String	Search query to filter issues.
offset	Int	Number of items to skip from the beginning of the result set.
before	String	Returns items before this cursor.
after	String	Returns items after this cursor.
first	Int	Returns the first N items.
last	Int	Returns the last N items.
occurrences	OccurrenceConnection!	Deprecated. Use `issues` instead. Issue occurrences found in the check.
analyzerIn	[String]	Filter occurrences by analyzer shortcodes.
offset	Int	Number of items to skip from the beginning of the result set.
before	String	Returns items before this cursor.
after	String	Returns items after this cursor.
first	Int	Returns the first N items.
last	Int	Returns the last N items.
metrics	RepositoryMetric!	List of DeepSource metrics captured in the check.

Summary of a check.

Field	Type	Description
occurrencesIntroduced	Int	Number of issues introduced in the check.
occurrencesResolved	Int	Number of issues resolved in the check.
occurrencesSuppressed	Int	Number of issues marked as suppressed in the check.
occurrenceDistributionByCategory	OccurrenceDistributionByCategory	The issue category distribution for the check.

Field	Type	Description
id	ID!	The ID of the object.
path	String!	File path where the issue occurrence was found.
beginLine	Int!	Starting line number of the issue in the file.
beginColumn	Int!	Starting column number of the issue in the file.
endLine	Int!	Ending line number of the issue in the file.
endColumn	Int!	Ending column number of the issue in the file.
issue	Issue!	The definition of the issue which has been raised.
title	String!	Title describing the issue which has been raised here.

Field	Type	Description
pageInfo	PageInfo!	Pagination data for this connection.
edges	[CheckEdge]!	Contains the nodes in this connection.
totalCount	Int	Total number of items in the connection.

A Relay edge containing a Check and its cursor.

Field	Type	Description
node	Check	The item at the end of the edge.
cursor	String!	A cursor for use in pagination.

Field	Type	Description
pageInfo	PageInfo!	Pagination data for this connection.
edges	[OccurrenceEdge]!	Contains the nodes in this connection.
totalCount	Int	Total number of items in the connection.

A Relay edge containing a Occurrence and its cursor.

Field	Type	Description
node	Occurrence	The item at the end of the edge.
cursor	String!	A cursor for use in pagination.

An issue occurrence found during code analysis.

Field	Type	Description
id	ID!	Unique identifier for this issue occurrence.
source	AnalysisIssueSource!	Source of this issue.
path	String!	File path where the issue was found.
severity	IssueSeverity!	Severity of the issue.
category	IssueCategory!	Category of the issue.
title	String	Description of the issue.
explanation	String	Detailed explanation of the issue.
isSuppressed	Boolean!	Whether this issue is suppressed.
beginLine	Int!	Starting line number.
beginColumn	Int!	Starting column number.
endLine	Int!	Ending line number.
endColumn	Int!	Ending column number.
createdAt	DateTime!	Time when the issue was first detected.
modifiedAt	DateTime!	Time when the issue was last modified.
shortcode	String	Issue shortcode. Null for AI issues.
issue	Issue	The issue definition. Null for AI issues.

Field	Type	Description
pageInfo	PageInfo!	Pagination data for this connection.
edges	[AnalysisIssueEdge]!	Contains the nodes in this connection.
totalCount	Int	Total number of items in the connection.

A Relay edge containing an AnalysisIssue and its cursor.

Field	Type	Description
node	AnalysisIssue	The item at the end of the edge.
cursor	String!	A cursor for use in pagination.