{
  "openapi": "3.0.1",
  "info": {
    "title": "Website Screenshot & Visual Change Monitor",
    "description": "Screenshot many URLs in desktop, laptop, tablet and mobile viewports in one run: full page, viewport or one element, as PNG, JPEG or PDF. Built-in visual change detection shows the % changed and a highlighted diff image. Pay only for successful screenshots.",
    "version": "1.0",
    "x-build-id": "7cAuidvC04iY7L8pl"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/jakob_jerich~website-screenshot-monitor/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-jakob_jerich-website-screenshot-monitor",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/acts/jakob_jerich~website-screenshot-monitor/runs": {
      "post": {
        "operationId": "runs-sync-jakob_jerich-website-screenshot-monitor",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor and returns information about the initiated run in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/runsResponseSchema"
                }
              }
            }
          }
        }
      }
    },
    "/acts/jakob_jerich~website-screenshot-monitor/run-sync": {
      "post": {
        "operationId": "run-sync-jakob_jerich-website-screenshot-monitor",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "inputSchema": {
        "type": "object",
        "required": [
          "urls"
        ],
        "properties": {
          "urls": {
            "title": "URLs",
            "type": "array",
            "description": "Public web pages to capture, one per line. A missing scheme gets https:// added. Duplicates are removed. Only http(s) URLs on public hosts are allowed.",
            "items": {
              "type": "string"
            }
          },
          "viewports": {
            "title": "Viewports / devices",
            "type": "array",
            "description": "Each URL is captured once per selected viewport. desktop = 1920×1080, laptop = 1366×768, tablet = 768×1024 (touch, tablet user agent), mobile = 390×844 (iPhone-like, touch, mobile user agent). Each capture is billed as one screenshot.",
            "items": {
              "type": "string",
              "enum": [
                "desktop",
                "laptop",
                "tablet",
                "mobile"
              ],
              "enumTitles": [
                "Desktop 1920×1080",
                "Laptop 1366×768",
                "Tablet 768×1024",
                "Mobile 390×844"
              ]
            },
            "default": [
              "desktop"
            ]
          },
          "highDpi": {
            "title": "High-DPI (retina) for tablet and mobile",
            "type": "boolean",
            "description": "Render tablet and mobile at 2× pixel density, like real devices: sharper images, but 4× the pixels, larger files and slower runs.",
            "default": false
          },
          "fullPage": {
            "title": "Full-page screenshot",
            "type": "boolean",
            "description": "Capture the whole scrollable page, not only the visible viewport. Very long pages are cut at 'Max full-page height'.",
            "default": true
          },
          "maxFullPageHeight": {
            "title": "Max full-page height (CSS px)",
            "minimum": 500,
            "maximum": 16000,
            "type": "integer",
            "description": "Safety limit for full-page captures, to avoid giant images from infinite-scroll pages.",
            "default": 10000
          },
          "selector": {
            "title": "Capture only this element (CSS selector)",
            "type": "string",
            "description": "Optional. Capture only the first element that matches this CSS selector, for example `#pricing` or `header`. If no element matches, the capture fails for that URL with a clear message, and you aren't charged."
          },
          "format": {
            "title": "Output format",
            "enum": [
              "png",
              "jpeg",
              "pdf"
            ],
            "type": "string",
            "description": "PNG is lossless and needed for change detection. JPEG (quality 80) makes much smaller files. PDF renders a printable A4 document (no viewport emulation; the selector option is ignored).",
            "default": "png"
          },
          "waitUntil": {
            "title": "Wait until",
            "enum": [
              "load",
              "domcontentloaded",
              "networkidle"
            ],
            "type": "string",
            "description": "When the page counts as loaded. 'load' suits most sites. 'networkidle' waits for background requests to stop (slower; can time out on sites that never stop requesting). 'domcontentloaded' is fastest.",
            "default": "load"
          },
          "delayMs": {
            "title": "Extra delay before capture (ms)",
            "minimum": 0,
            "maximum": 30000,
            "type": "integer",
            "description": "Extra time to wait after the page has loaded, for animations, fonts and late content.",
            "default": 1000
          },
          "waitForSelector": {
            "title": "Wait for element (CSS selector)",
            "type": "string",
            "description": "Optional. Wait until an element that matches this selector is visible before capturing. It's skipped with a warning if the element doesn't appear within the navigation timeout."
          },
          "scrollToBottom": {
            "title": "Scroll through the page first",
            "type": "boolean",
            "description": "Scroll down the page step by step before capturing, so lazy-loaded images and sections render. Recommended for full-page captures of long pages.",
            "default": false
          },
          "hideCookieBanners": {
            "title": "Hide cookie banners",
            "type": "boolean",
            "description": "Hide common cookie-consent pop-ups (OneTrust, Cookiebot, Didomi, Usercentrics, Quantcast, Osano and others) with CSS so they don't cover the content. Nothing is clicked or accepted.",
            "default": true
          },
          "hideSelectors": {
            "title": "Hide elements (CSS selectors)",
            "type": "array",
            "description": "Optional CSS selectors of elements to hide before capturing, for example chat widgets, ads or rotating banners. Useful to reduce noise in change detection.",
            "items": {
              "type": "string"
            }
          },
          "darkMode": {
            "title": "Dark mode",
            "type": "boolean",
            "description": "Emulate prefers-color-scheme: dark, for sites that support a dark theme.",
            "default": false
          },
          "compareWithPrevious": {
            "title": "Detect visual changes (compare with previous run)",
            "type": "boolean",
            "description": "Compare each PNG screenshot pixel by pixel with the one from the previous run with the same URL, viewport and settings. Output gets changePercent, changed and a highlighted diff image. The first run only stores the baseline. Requires PNG format. Run it on a schedule to monitor pages.",
            "default": false
          },
          "monitorStoreName": {
            "title": "Baseline storage name",
            "type": "string",
            "description": "Name of the key-value store in your account that keeps the baseline screenshots between runs. Use different names to keep separate monitoring projects apart. Allowed: letters, digits and '-'.",
            "default": "screenshot-monitor-baselines"
          },
          "changeThresholdPercent": {
            "title": "Change threshold (%)",
            "minimum": 0,
            "maximum": 100,
            "type": "number",
            "description": "Minimum share of changed pixels (in %) for a capture to be marked changed = true. 0.1 catches small text edits on a typical page. Raise it (for example to 1–5) to ignore noise such as rotating ads or carousels.",
            "default": 0.1
          },
          "navigationTimeoutSecs": {
            "title": "Navigation timeout (seconds)",
            "minimum": 5,
            "maximum": 180,
            "type": "integer",
            "description": "Maximum time to wait for each page. If the page doesn't reach the 'wait until' event in time, it's captured as rendered so far (loadComplete = false) and isn't dropped. Pages that fail to open are retried once.",
            "default": 30
          }
        }
      },
      "runsResponseSchema": {
        "type": "object",
        "properties": {
          "data": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "actId": {
                "type": "string"
              },
              "userId": {
                "type": "string"
              },
              "startedAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-01-08T00:00:00.000Z"
              },
              "finishedAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-01-08T00:00:00.000Z"
              },
              "status": {
                "type": "string",
                "example": "READY"
              },
              "meta": {
                "type": "object",
                "properties": {
                  "origin": {
                    "type": "string",
                    "example": "API"
                  },
                  "userAgent": {
                    "type": "string"
                  }
                }
              },
              "stats": {
                "type": "object",
                "properties": {
                  "inputBodyLen": {
                    "type": "integer",
                    "example": 2000
                  },
                  "rebootCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "restartCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "resurrectCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "computeUnits": {
                    "type": "integer",
                    "example": 0
                  }
                }
              },
              "options": {
                "type": "object",
                "properties": {
                  "build": {
                    "type": "string",
                    "example": "latest"
                  },
                  "timeoutSecs": {
                    "type": "integer",
                    "example": 300
                  },
                  "memoryMbytes": {
                    "type": "integer",
                    "example": 1024
                  },
                  "diskMbytes": {
                    "type": "integer",
                    "example": 2048
                  }
                }
              },
              "buildId": {
                "type": "string"
              },
              "defaultKeyValueStoreId": {
                "type": "string"
              },
              "defaultDatasetId": {
                "type": "string"
              },
              "defaultRequestQueueId": {
                "type": "string"
              },
              "buildNumber": {
                "type": "string",
                "example": "1.0.0"
              },
              "containerUrl": {
                "type": "string"
              },
              "usage": {
                "type": "object",
                "properties": {
                  "ACTOR_COMPUTE_UNITS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_WRITES": {
                    "type": "integer",
                    "example": 1
                  },
                  "KEY_VALUE_STORE_LISTS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_INTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_SERPS": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_UNBLOCKER_UNITS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              },
              "usageTotalUsd": {
                "type": "number",
                "example": 0.00005
              },
              "usageUsd": {
                "type": "object",
                "properties": {
                  "ACTOR_COMPUTE_UNITS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_WRITES": {
                    "type": "number",
                    "example": 0.00005
                  },
                  "KEY_VALUE_STORE_LISTS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_INTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_SERPS": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_UNBLOCKER_UNITS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}