Skip to main content
VertaaUX Docs

get_findings

Retrieve findings from a completed audit

get_findings

Retrieve the findings from a completed audit with optional filtering by severity, rule, or status.

Description

The get_findings tool returns the full list of findings from a completed audit. Use filtering parameters to narrow down results by severity, rule ID, or finding status.

Parameters

ParameterTypeRequiredDescription
audit_idstringrequiredAudit ID from audit_url response
severity'critical' | 'serious' | 'moderate' | 'minor'optionalFilter by severity level
rule_idstringoptionalFilter by specific rule ID (e.g., "color-contrast")
status'open' | 'fixed' | 'ignored'optionalFilter by finding status
limitnumberoptionalMaximum number of findings to return. Default: 50
offsetnumberoptionalSkip this many findings (for pagination). Default: 0

Response

Returns an array of finding objects:

type
itemsobject
idstring

Unique finding identifier

Example: "fnd_xyz789"

rule_idstring

Rule that triggered this finding

Example: "color-contrast"

severitystring

Severity level

Example: "serious"

messagestring

Human-readable description

Example: "Text has insufficient color contrast ratio"

elementobject

Element information

selectorstring

CSS selector

Example: ".hero-text"

htmlstring

HTML snippet

Example: "<p class=\"hero-text\">Welcome</p>"

bounding_boxobject

Element position

wcagstring

Related WCAG criterion

Example: "1.4.3"

statusstring

Finding status

Example: "open"

Example Conversations

Get All Findings

"Show me all findings from audit aud_abc123"

get_findings({
  audit_id: "aud_abc123"
})

Filter by Severity

"Get all critical findings from the last audit"

get_findings({
  audit_id: "aud_abc123",
  severity: "critical"
})

Filter by Rule

"Show me all color contrast issues"

get_findings({
  audit_id: "aud_abc123",
  rule_id: "color-contrast"
})

Paginated Results

"Get the next 10 findings after the first 50"

get_findings({
  audit_id: "aud_abc123",
  limit: 10,
  offset: 50
})

Common Rule IDs

Rule IDDescriptionSeverity
color-contrastInsufficient text contrastserious
image-altMissing alt textcritical
button-nameButton lacks accessible namecritical
link-nameLink lacks accessible nameserious
labelForm input missing labelcritical
heading-orderIncorrect heading hierarchymoderate
focus-visibleMissing focus indicatorserious
keyboardNot keyboard accessiblecritical

Workflow Example

Typical flow after getting findings:

1. audit_url → Get audit_id
2. get_findings (severity: critical) → Review critical issues
3. explain_finding → Understand specific issue
4. suggest_fix → Get code to fix it

Error Handling

ErrorCauseSolution
AUDIT_NOT_FOUNDInvalid audit_idVerify audit_id from audit_url response
AUDIT_NOT_COMPLETEAudit still runningWait for audit to complete or check status
INVALID_FILTERInvalid filter valueCheck severity/status enum values

Was this page helpful?

On this page