Skip to main content

Website Health

pro
GET/v1/composite/website-health

Runs SEO, accessibility, and privacy audits in parallel and returns a unified website health score with individual component grades. The SEO component uses on-page analysis only (title, meta, headings, content, canonical, structured data, hreflang) — for comprehensive SEO scoring including Core Web Vitals, technical SEO, and content quality, use the dedicated /v1/scores/seo endpoint. Accessibility checks are aligned with WCAG 2.2 Level AA criteria, the standard referenced by the European Accessibility Act (EAA) and Section 508. Privacy analysis covers cookie compliance, consent management detection (TCF, granular consent, Google Consent Mode v2), tracker identification, CCPA Do Not Sell link detection, cookie wall detection, and GDPR/CCPA readiness indicators. Handles partial failures gracefully — if one audit component or even the initial HTML fetch is unreachable, available results are still returned with the overall score recalculated from successful components.

What It Does

Fetches the target domain's HTML and runs three parallel audits: (1) SEO audit covering title tags, meta descriptions, heading hierarchy, image alt text, link analysis, content depth, Open Graph, and Twitter Card completeness; (2) Accessibility audit checking 23 WCAG criteria including ARIA landmarks, semantic HTML, form labels, heading order, skip navigation, viewport zoom, autoplay media, and focus management; (3) Privacy audit analyzing cookies (first/third-party, Secure/HttpOnly/SameSite flags), consent banner detection, privacy policy presence, and third-party tracker identification. Returns individual scores and grades per component, an overall weighted health score, and the top 5 highest-impact recommendations across all dimensions.

Why It's Useful

Modern website quality is measured across three pillars: search visibility (SEO), legal compliance (accessibility under WCAG 2.2 / EAA / ADA), and user trust (privacy and data protection under GDPR / CCPA). This endpoint provides a holistic quality assessment in a single API call — essential for CI/CD quality gates, executive dashboards, and regulatory compliance monitoring.

Use Cases

Compliance Officer

EAA / ADA Compliance Monitoring

Monitor website accessibility compliance against WCAG 2.2 Level AA standards required by the European Accessibility Act (effective June 2025) and ADA. Track SEO and privacy as secondary quality indicators.

Automated compliance monitoring with scored results for audit documentation and regulatory reporting.

DevOps / QA Engineer

CI/CD Quality Gate

Integrate website health checks into deployment pipelines to catch SEO regressions, accessibility violations, and privacy compliance issues before they reach production.

Prevent deployments that degrade search rankings, break accessibility, or violate cookie consent requirements.

Digital Agency

Client Reporting Dashboard

Generate automated website health reports for clients showing SEO, accessibility, and privacy scores with actionable recommendations and grade trends over time.

Demonstrate measurable improvement across all quality dimensions with a single API integration.

Parameters

NameTypeRequiredDescription
domainstringRequiredThe domain to assess website health for (e.g., example.com)Example: example.com
componentsstringOptionalComma-separated list of components to run: seo, accessibility, privacy. Defaults to all.Example: seo,privacy
detailstringOptionalSet to "full" to include per-component score breakdowns in the response.Example: full
force_refreshstringOptionalSet to "true" to bypass cache and get fresh results.Example: true

Response Fields

FieldTypeDescription
domainstringThe assessed domain
timestampstringISO 8601 timestamp of the assessment
scoresobjectIndividual audit scores: seo, accessibility, privacy — each with score (0-100), grade (A+ to F), and available flag. Includes per-component breakdown when detail=full. Null if the component failed or was not requested.
overallScorenumberAverage health score (0-100) calculated from available components. Null when all components fail.
overallGradestringOverall health grade: A+ (95+), A (85+), B (70+), C (50+), D (30+), F (<30)
overallGradeDescriptionstringHuman-readable description of the overall grade (e.g., "Excellent", "Good", "Needs Improvement"). Null when all components fail.
topRecommendationsarrayTop 5 highest-impact deduplicated recommendations, each with text, source (seo|accessibility|privacy), and severity (high|medium|low), prioritized by score deficit
warningsarrayWarnings about analysis reliability (e.g., SPA detection, HTTP error pages). Only present when applicable.
metaobjectRequest metadata: request_id, response_time_ms, components_fetched (0-3), partial_failure flag, errors per component

Code Examples

cURL
curl "https://api.edgedns.dev/v1/composite/website-health" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d "domain=example.com"
JavaScript
const response = await fetch(
  'https://api.edgedns.dev/v1/composite/website-health?domain=example.com',
  {
    headers: {
      'Authorization': 'Bearer YOUR_API_KEY'
    }
  }
);

const data = await response.json();
console.log(data);
Python
import requests

response = requests.get(
    'https://api.edgedns.dev/v1/composite/website-health',
    headers={'Authorization': 'Bearer YOUR_API_KEY'},
    params={
    'domain': 'example.com'
    }
)

data = response.json()
print(data)

Read the full Website Health guide

Why it matters, real-world use cases, parameters, response fields, and how to call it from Claude, ChatGPT, or Gemini via MCP.

Read the guide →

Related Endpoints

External References

Learn more about the standards and protocols behind this endpoint.

Try This Endpoint

Test the Website Health endpoint live in the playground.