Overview

Generate professional PDF audit reports for client delivery. These comprehensive reports include executive summaries, detailed validation results, score breakdowns, and actionable recommendations — suitable for presentation to stakeholders.

How It Works

1. Select a project or set of URLs
2. Configure report sections:
– Executive summary
– Validation detail per URL
– Score breakdown by schema type
– Error and warning summary
– Recommendations and next steps
3. Generate the PDF
4. Download or email to recipients
5. Enterprise: reports use white-label branding

Tier Availability

| Tier | Available | White-Label |
|——|———–|————-|
| Free | No | — |
| Pro | No | — |
| Agency | Yes | No |
| Enterprise | Yes | Yes |

Related Features

– Export CSV/PDF: Simpler export format
– Scheduled Email Reports: Automated report delivery
– Client Portal: Alternative way to share results with clients

Mini-Tutorial

Step 1: Select Project

Navigate to Projects and select the project you want to audit (Agency+ only).

Step 2: Configure Report Sections

Click “Generate Audit Report.” A wizard appears with options:
– Executive Summary: High-level score and findings
– Detailed Analysis: Per-URL breakdown
– Error Report: All errors grouped by type
– Recommendations: Next steps to improve

Step 3: Choose Branding (Enterprise)

If your account has white-label enabled, choose to use your branded logo and colors or ValidGraph’s.

Step 4: Generate PDF

Click “Generate Report.” The system compiles your data into a professional PDF (usually 2-5 minutes).

Step 5: Download or Email

Download the PDF directly or email it to clients/stakeholders. Use the “Schedule” option for future auto-generation.

Technical Details

Request

POST /api/v1/export/pdf
{
  "project_id": "proj_abc123",
  "include_sections": [
    "executive_summary",
    "detailed_analysis",
    "error_breakdown",
    "recommendations"
  ],
  "branding": "white_label",
  "format": "audit"
}

Response:

{
  "export_id": "export_xyz789",
  "status": "processing",
  "estimated_wait_seconds": 120,
  "check_status_url": "/api/v1/export/xyz789/status"
}

Check Export Status

GET /api/v1/export/xyz789/status

When ready:

{
  "export_id": "export_xyz789",
  "status": "ready",
  "file_url": "https://cdn.validgraph.io/exports/xyz789.pdf",
  "file_size_bytes": 2456789,
  "expires_at": "2025-03-29T14:30:00Z"
}

Sample Report Structure

– Page 1: Title with logo/branding, generated date
– Page 2: Executive summary (scores, trends, key issues)
– Pages 3-4: Detailed breakdown (URLs, types, errors)
– Page 5: Error heatmap (most common issues)
– Page 6: Recommendations (prioritized actions)
– Last Page: Footer with white-label attribution

References

– PDF/A Specification (ISO 19005)
– Professional Report Design Best Practices
– Accessibility in PDF Documents (WCAG)
– ValidGraph Audit Report API