Audit website GDPR privacy compliance with HTML reports API

Audit a website's GDPR signals from its address. It fetches the homepage, looks for common tracking scripts (Google Tag Manager, Meta Pixel, Hotjar) and

Input

Send these Fields as input. A Field not listed here is refused.

website_url

Website URL (including https://)

  • Type: string
  • Required: yes
  • Length in characters: 1 to 2000

Run it

One call presses the Widget and answers the run once its status is succeeded or failed, however long it takes. The key is read from ABYSS_API_KEY. Install the library with npm install abysshub or pip install abysshub; cURL sends the Fields as a form.

JavaScript

// index.mjs
import Abyss from "abysshub";

const abyss = new Abyss();

const run = await abyss.run("widget_388", {
  website_url: "https://www.gov.uk/",
});

console.log(run.result);
for (const path of await run.save("output")) {
  console.log(path);
}

Python

from abysshub import Abyss

abyss = Abyss()

run = abyss.run("widget_388", {
    "website_url": "https://www.gov.uk/",
})

print(run.result)
for path in run.save("output"):
    print(path)

cURL

curl https://api.abysshub.com/v1/widgets/widget_388/runs \
  -H "Authorization: Bearer $ABYSS_API_KEY" \
  -F website_url=https://www.gov.uk/

A succeeded run carries its result and its output_files. Their URLs are signed for each read: re-read the run, never store a URL. A run still queued or running in the answer (after an hour, or when the API is busy) is read again at its Location with ?wait=true.

What it answers

The Example Run's result, the JSON the Widget wrote to output/output.json:

{
  "website_url": "https://www.gov.uk/",
  "score": 100,
  "score_color": "#38a169",
  "trackers_detected": [],
  "has_cookie_consent": true,
  "has_privacy_policy": true,
  "can_grade": true,
  "policy_url": "https://www.gov.uk/help/privacy-notice",
  "gap_count": 0,
  "summary_line": "No compliance gaps were identified.",
  "site_score_message": "You've built a strong data protection foundation aligned with the GDPR. A few small refinements will help you stay ahead and keep visitor trust high.",
  "gaps": [
    "No major site-level compliance gaps detected in this automated scan."
  ],
  "quality_score": 78,
  "quality_band": "Above Average",
  "quality_criteria": [
    {
      "label": "Data Controller Identity & Contact Details",
      "weight": 10,
      "points": 1,
      "result": "Partial"
    },
    {
      "label": "Specified & Legitimate Purposes of Processing",
      "weight": 15,
      "points": 2,
      "result": "Compliant"
    },
    {
      "label": "Lawful Basis & Consent",
      "weight": 15,
      "points": 2,
      "result": "Compliant"
    },
    {
      "label": "Data Subject Rights & Supervisory Authority",
      "weight": 20,
      "points": 1,
      "result": "Partial"
    },
    {
      "label": "International Data Transfers",
      "weight": 15,
      "points": 1,
      "result": "Partial"
    },
    {
      "label": "Security, Confidentiality & Data Retention",
      "weight": 15,
      "points": 2,
      "result": "Compliant"
    },
    {
      "label": "Plain Language & Transparency",
      "weight": 10,
      "points": 2,
      "result": "Compliant"
    }
  ],
  "report_file": "gdpr-audit-report.html"
}

More

Keys, files, errors and limits: API access.