Read and export scan reports

What this guide covers

When a scan finishes, Oobee writes a folder of reports. This guide shows how to find the folder, read the interactive HTML report, and export the results as CSV, zip or JSON files. It does not describe every file field. For that, refer to Scan report files.

Prerequisites

A completed scan. Refer to Run a scan.
A web browser to open report.html.

Step 1: Find the results folder

Oobee creates a folder for each scan inside results, in the folder where you ran the scan. The folder name contains the scan date, time and the domain or file name that was scanned. If you set -e, Oobee creates the scan folder inside that folder instead of inside results. If the default results folder is not writable, Oobee writes to an Oobee folder in your Documents folder (Windows and macOS) or home folder (Linux).

The folder contains these files by default:

File	Contents
`report.html`	Interactive report
`summary.pdf`	Printable summary of issue types and counts
`report.csv`	Every issue, one row each
`scanDetails.csv`	The scan data, scan items and scan items summary as Base64 text, for tools that import scan results

Element screenshots are saved in the same folder when screenshots are on, which is the default.

Step 2: Open the HTML report

Open report.html in a browser. The report has these sections:

Section	What it shows
WCAG Score and WCAG Compliance	The score for the scanned pages and the criteria that failed
Pages with the most issues	The pages with the most issues, to fix first
Prioritise these issues first	The issues to tackle first
All Issues	Every rule that failed, grouped by severity
Scan results	Pages Scanned, Pages Not Scanned and Unsupported Documents
About this scan	The scan type, device, start URL and time

Oobee sorts issues into three categories:

Must Fix — WCAG Level A and AA failures.
Good to Fix — WCAG Level AAA failures and best-practice rules.
Manual Review Required — results that may be false positives and need a person to confirm.

Refer to Scan rules and severity for which rule falls in which category.

Step 3: Work through the issues

Select a rule in All Issues to open its details. For each rule, the report shows how to fix it and where to find it. You can group the affected items by page or by HTML element. Fix Must Fix issues first, then Good to Fix, and confirm the Manual Review Required items by hand.

Step 4: Export the results

Choose the format for your use:

Share the report folder: add -o <FILENAME>.zip to the scan to also write the whole results folder to a zip file.
Analyse in a spreadsheet: open report.csv. It has one row per issue with severity, rule, WCAG criteria, page URL, HTML context, how to fix, and XPath.
Process with your own tools: add -g yes to the scan to keep the JSON files, such as scanData.json.gz.b64 and scanItems.json.gz.b64. Decode a file with:

base64 -d scanData.json.gz.b64 | gunzip > scanData.json

On macOS, use base64 -D -i scanData.json.gz.b64 | gunzip > scanData.json.

Constraints and limitations

Constraint	Detail
JSON files	Oobee deletes the JSON files after the report is built unless you scan with `-g yes`. With `-g yes`, Oobee keeps both the compressed `.json.gz.b64` files and the uncompressed `.json` files.
Large scans	If the scan data exceeds about 510 MB, `report.html` does not show the individual issues. Use `report.csv` for the issue details.
Passed items	`scanItems.json` omits passed items. Passed counts remain in `scanData.json`.
Element screenshots	A screenshot can time out after 5 seconds when an element moves out of view, for example in an animated carousel.
Skipped pages	Pages Oobee could not scan are listed under Pages Not Scanned or Unsupported Documents, with a reason.
Summary PDF	Creating `summary.pdf` needs a working browser. Oobee writes `report.html` and `report.csv` before the PDF step.

Scan report files — every file and field.
Scan rules and severity — each rule and its category.
Troubleshooting — pages skipped and incomplete reports.

Reports

Scan report files