IsPixelWorking

Check whether a web page's Meta Pixel (Facebook Pixel) works: cookie consent, duplicate events, event IDs, the ad click ID (fbclid -> _fbc) and signs of server-side tracking. A browser in the EU visits the page twice. Reuses a result from the last 24 hours unless recheck is true. Waits for the result up to wait_seconds (a check takes 20 to 60 seconds); if it is still running, call get_report later.

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "minLength": 3,
      "maxLength": 2048,
      "description": "The page to check, usually the landing page the ads point to, e.g. https://example.com/landing"
    },
    "recheck": {
      "description": "Start a fresh check instead of reusing a recent result (allowed once the last check is an hour old). Use after a fix was deployed.",
      "type": "boolean"
    },
    "wait_seconds": {
      "description": "How long to wait for the result, 0 to 45 seconds (default 40).",
      "type": "integer",
      "minimum": 0,
      "maximum": 45
    }
  },
  "required": [
    "url"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Read the result of a check by its report id or report link (https://ispixelworking.com/r/<id>): status, grade, problems with explanations and fix guide links, checklist. Reports are kept for 90 days.

{
  "type": "object",
  "properties": {
    "report": {
      "type": "string",
      "minLength": 8,
      "maxLength": 200,
      "description": "Report id (e.g. Ab3dE5fG7hJ9kL2m) or report link"
    }
  },
  "required": [
    "report"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Step-by-step guide (Markdown) for fixing a problem the check found, for the site's platform when one exists (otherwise the general version). With consent_tool, returns the guide for wiring the Meta Pixel to that consent tool instead. Guides exist for: meta.fires_before_consent, meta.not_firing_after_consent, meta.duplicate_pixel, meta.missing_event_id, meta.fbc_not_set, and general.server_side_not_detected (setting up the Conversions API).

{
  "type": "object",
  "properties": {
    "issue_id": {
      "description": "Problem id from a report, e.g. meta.fires_before_consent",
      "type": "string",
      "maxLength": 80
    },
    "platform": {
      "description": "Site platform from the report, e.g. framer, shopify, webflow, wordpress",
      "type": "string",
      "maxLength": 40
    },
    "consent_tool": {
      "description": "Consent tool guide: complianz (Complianz), cookiebot (Cookiebot), cookieyes (CookieYes), onetrust (OneTrust), usercentrics (Usercentrics)",
      "type": "string",
      "enum": [
        "complianz",
        "cookiebot",
        "cookieyes",
        "onetrust",
        "usercentrics"
      ]
    }
  },
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Every problem (finding) the check can report, with id, severity, title, explanation and whether a fix guide exists.

{
  "type": "object",
  "properties": {}
}