Analysis run A `Run` is an analysis done against your codebase.
Use this to check the results of a specific analysis run — whether triggered by a push, PR, or manual run. You can look up a run by its UID or the commit SHA.
Query: run fetch the details of a single run using either the runUid identifier or commitOid.
Field Type Description runUid UUID UID of the Analysis Run you want to get. commitOid String Commit OID of the Analysis Run you want to get.
query { run ( runUid : "0613332b-436a-429b-95e3-6e01d72208b3" ) { id createdAt branchName baseOid finishedAt } } or,
query { run ( commitOid : "6df7f08b029abbf25905abf1bc79fde72934045b" ) { id createdAt branchName baseOid finishedAt } } { "data" : { "run" : { "id" : "QW5hbHlzaXNadW46eHpkZ3Zi" , "createdAt" : "2019-01-07T20:52:19.491314+00:00" , "branchName" : "foobar" , "finishedAt" : "2019-01-07T20:52:34.677357+00:00" } } } Field Type Description createdAt DateTime !The time at which the Run was created. branchName String The branch name against which the analysis was run. baseOid String The commit ID which acts as the root for the Analysis. All issues introduced in the code before this commit are ignored by DeepSource. commitOid String The commit ID on which the Analysis is run. finishedAt DateTime The time at which the Run completed. repository Repository !The repository on which the Analysis has run. id ID !The ID of the object. runUid UUID !UID of this AnalysisRun. status AnalysisRunStatus !The current status of the run. summary AnalysisRunSummary !Summary of the analysis run. changesetStats ChangesetStats Statistics pertaining to the changeset (of a commit or PR) in the analysis run. updatedAt DateTime !Time when the analysis run was last modified. reportCard RunReport The report card for this analysis run. scaChecks SCACheckConnection SCA checks in the analysis run. 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. checks CheckConnection !Analyzer checks in the analysis run. 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.
Field Type Description pageInfo PageInfo !Pagination data for this connection. edges [AnalysisRunEdge ]! Contains the nodes in this connection. totalCount Int The total number of analysis runs in the connection.
A Relay edge containing a AnalysisRun and its cursor.
Field Type Description node AnalysisRun The item at the end of the edge. cursor String !A cursor for use in pagination.
Field Type Description occurrencesIntroduced Int Number of issues introduced during this analysis run, between the `baseOid` and the `commitOid` occurrencesResolved Int Number of issues marked as resolved in this analysis run occurrencesSuppressed Int Number of issues marked as suppressed in this analysis run. occurrenceDistributionByAnalyzer OccurrenceDistributionByAnalyzer Number of issues raised per analyzer. occurrenceDistributionByCategory [OccurrenceDistributionByCategory ] Number of issues raised per issue category. vulnerabilitiesIntroduced Int Number of vulnerabilities introduced in this analysis run.
Field Type Description analyzerShortcode String !Shortcode of the analyzer. introduced Int !Number of issues detected by the analyzer.
Field Type Description category IssueCategory !Category of the issue. introduced Int !Number of issues detected that belong to this category.
Statistics pertaining to the changeset (of a commit or PR), as analyzed by an AnalysisRun.
Overall and newly added number of lines (or branches or conditions) in a changeset. Note: 0 depicts no lines (or branches or conditions) were found whereas None depicts the information is not available.
Field Type Description overall Int Overall number of lines (or branches or conditions) across the repository. overallCovered Int Overall number of lines (or branches or conditions) that are covered across the repository. new Int Newly added number of lines (or branches or conditions) in the changeset. newCovered Int Newly added number of lines (or branches or conditions) that are covered in the changeset.
Report card generated for an analysis run.
A dimension evaluated in a run report card.
Field Type Description grade RunReportGrade !Letter grade (A, B, C, or D). score Int !Numeric score (0-100). issuesCount Int !Number of issues in this dimension. summary String Human-readable summary of the dimension.
Code coverage metrics for an analysis run.
Field Type Description grade RunReportGrade Letter grade (A, B, C, or D). score Int Numeric coverage score (0-100). lineCoverage Float Percentage of lines covered by tests. branchCoverage Float Percentage of branches covered by tests.
Aggregate code quality score across all dimensions.
Field Type Description grade RunReportGrade !Overall letter grade (A, B, C, or D). score Int !Overall numeric score (0-100).
Metadata for a run report.
Field Type Description linesChanged Int !Number of lines analyzed. filesChanged Int !Number of files analyzed. capped Boolean !Whether the aggregate grade was capped due to critical or security issues. capReason String Reason for grade capping.
Suggested area to focus on for code quality improvement.
Field Type Description dimension String The dimension to focus on improving. action String Recommended action to take.
A single SCA (Software Composition Analysis) check as part of an analysis run.
Field Type Description id ID !The ID of the object. sequence Int !Sequence number of the SCA check in the analysis run. status SCACheckStatus !The current status of the SCA check. target RepositoryTarget The repository target for which this SCA check was performed. createdAt DateTime !Time when the SCA check was created. updatedAt DateTime !Time when the SCA check was last modified. finishedAt DateTime Time when the SCA check finished. summary SCACheckSummary !Summary of the SCA check. vulnerabilityOccurrences VulnerabilityOccurrenceConnection Vulnerability occurrences found in the SCA check.
Summary of an SCA check.
Field Type Description vulnerabilitiesIntroduced Int Number of vulnerabilities introduced in the SCA check.
Field Type Description pageInfo PageInfo !Pagination data for this connection. edges [SCACheckEdge ]! Contains the nodes in this connection. totalCount Int Total number of items in the connection.
A Relay edge containing a SCACheck and its cursor.
Field Type Description node SCACheck The item at the end of the edge. cursor String !A cursor for use in pagination.
