{
  "openapi": "3.0.1",
  "info": {
    "title": "Website Change Monitor - Page Change Detection & Alerts",
    "description": "Website change tracker and content monitor: text and price changes, CSS selector per URL, keyword triggers, noise filters, screenshots, email, Slack, Discord, webhook alerts, AI summary. $2/1k checks.",
    "version": "0.1",
    "x-build-id": "KZJ1BJbkggMipm9Pw"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/tidytools~website-change-monitor/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-tidytools-website-change-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/tidytools~website-change-monitor/runs": {
      "post": {
        "operationId": "runs-sync-tidytools-website-change-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/tidytools~website-change-monitor/run-sync": {
      "post": {
        "operationId": "run-sync-tidytools-website-change-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",
        "properties": {
          "urlList": {
            "title": "Pages to watch",
            "type": "array",
            "description": "Main input (fill this, or `urls`). Pages to check for changes, one URL per line (lines with several URLs separated by commas or spaces are split; lines that are not URLs get an error row and are not charged). Run this Actor on a schedule (e.g. daily) to be told what changed since the last run.",
            "items": {
              "type": "string"
            }
          },
          "urls": {
            "title": "Pages with per-page settings (optional)",
            "type": "array",
            "description": "Same as the list above, plus optional per-page settings: add user data such as {\"selector\": \"#pricing\", \"name\": \"Competitor pricing\"} to a URL (Advanced mode of this list, or in JSON input). You can also link a text file with one URL per line.",
            "items": {
              "type": "object",
              "required": [
                "url"
              ],
              "properties": {
                "url": {
                  "type": "string",
                  "title": "URL of a web page",
                  "format": "uri"
                }
              }
            }
          },
          "monitorName": {
            "title": "Monitor name",
            "type": "string",
            "description": "Runs with the same name compare against each other. Use different names for independent monitors (e.g. \"competitor-prices\").",
            "default": "default"
          },
          "cssSelector": {
            "title": "Only watch this part of the page (CSS selector)",
            "type": "string",
            "description": "Optional, e.g. \"main\", \"#pricing\" or \".product-price\". Leave empty to watch the whole page. A per-page \"selector\" in user data overrides it. Changing it saves a new baseline instead of reporting a change."
          },
          "ignorePatterns": {
            "title": "Ignore lines matching",
            "type": "array",
            "description": "Optional regular expressions for noisy lines, e.g. \"^Updated\", \"\\d+ views\", \"Copyright\". Matching lines are not compared.",
            "items": {
              "type": "string"
            }
          },
          "outputOnlyChanges": {
            "title": "Only output changed pages",
            "type": "boolean",
            "description": "Skip unchanged pages in the results (they are still checked and charged).",
            "default": false
          },
          "mode": {
            "title": "Page fetching (HTTP or browser)",
            "enum": [
              "auto",
              "fast",
              "browser"
            ],
            "type": "string",
            "description": "\"Auto\" reads pages over plain HTTP and switches to a real browser for sites that block it or need JavaScript. Values: auto = Auto (recommended); fast = Fast (HTTP only); browser = Browser (JavaScript rendering).",
            "default": "auto"
          },
          "maxConcurrency": {
            "title": "Parallel pages",
            "minimum": 1,
            "maximum": 20,
            "type": "integer",
            "description": "How many pages are checked at the same time.",
            "default": 5
          },
          "notifyEmail": {
            "title": "E-mail changes to",
            "type": "string",
            "description": "Optional. The e-mail address of your Apify account (apify/send-mail delivers only to the account owner). When pages changed, a summary e-mail is sent by running apify/send-mail on your account (a few seconds of platform usage)."
          },
          "webhookUrl": {
            "title": "Webhook URL for changes",
            "type": "string",
            "description": "Optional. When at least one page changed (or was removed, or the run stopped at your charge limit), a summary is POSTed here. Slack and Discord webhook URLs get a formatted message; other URLs (Zapier, Make, n8n, your app) get JSON."
          },
          "webhookSecret": {
            "title": "Webhook signing secret",
            "type": "string",
            "description": "Optional. Signs the webhook body with HMAC-SHA256 in the X-Signature-256 header (sha256=<hex>) so your endpoint can verify it."
          },
          "alertOnRemoved": {
            "title": "Alert when a page is removed",
            "type": "boolean",
            "description": "When a watched page answers 404 or 410, report it as \"removed\" and notify once (e-mail / webhook), then \"restored\" when it is back. Not charged. The baseline is kept.",
            "default": true
          },
          "alertOnError": {
            "title": "Alert when a page keeps failing",
            "type": "boolean",
            "description": "Also notify (e-mail / webhook) when a page could not be read, or its CSS selector matched nothing, several runs in a row, and again when it works again. Stops monitors from failing silently.",
            "default": false
          },
          "errorThreshold": {
            "title": "Failures in a row before an error alert",
            "minimum": 1,
            "maximum": 100,
            "type": "integer",
            "description": "Used with \"Alert when a page keeps failing\". 1 = alert on the first failure. Each failure streak is alerted once.",
            "default": 3
          },
          "screenshotOnChange": {
            "title": "Screenshot changed pages",
            "type": "boolean",
            "description": "Save a screenshot (JPEG) when the baseline is saved and on every alerted change. Only the watched element is captured when a CSS selector is set. Results and alerts link the new screenshot (screenshotUrl) and the previous one (previousScreenshotUrl, the \"before\" image). Charged per screenshot; stored in the monitor's key-value store (the 5 newest per page are kept).",
            "default": false
          },
          "dryRunNotifications": {
            "title": "Test alerts without sending",
            "type": "boolean",
            "description": "Prepare alerts but do not deliver them: the webhook is not called and the e-mail uses send-mail's mock mode. The result is recorded in the SUMMARY record.",
            "default": false
          },
          "watchKeywords": {
            "title": "Only alert when these words appear in the change",
            "type": "array",
            "description": "Optional, e.g. \"price\", \"out of stock\", \"discontinued\". A change counts as significant only if an added or removed line contains one of them (case-insensitive). Matches are listed in matchedKeywords.",
            "items": {
              "type": "string"
            }
          },
          "minChangedLines": {
            "title": "Minimum changed lines",
            "minimum": 0,
            "type": "integer",
            "description": "Changes with fewer added + removed lines are reported as minor (significant: false) and do not trigger alerts. 0 = off.",
            "default": 0
          },
          "minChangeRatio": {
            "title": "Minimum change ratio",
            "type": "string",
            "description": "Optional number between 0 and 1, e.g. 0.05 = at least 5% of the page changed. Smaller changes are minor and do not trigger alerts. Empty = off."
          },
          "ignoreCommonNoise": {
            "title": "Ignore dates, times and counters",
            "type": "boolean",
            "description": "Treat lines that differ only in dates, clock times, \"5 minutes ago\" or view/like counters as unchanged.",
            "default": false
          },
          "ignoreSelectors": {
            "title": "Ignore these parts of the page (CSS selectors)",
            "type": "array",
            "description": "Optional, e.g. \".carousel\", \"#ads\", \".related-posts\". These elements are removed before comparing, so rotating banners or recommendations do not count as changes.",
            "items": {
              "type": "string"
            }
          },
          "wholePageFallback": {
            "title": "Fall back to the whole page if the selector is missing",
            "type": "boolean",
            "description": "When the CSS selector matches nothing, compare the whole page instead. Off: the page is reported as \"selector-not-found\" (not charged, baseline kept).",
            "default": false
          },
          "aiSummary": {
            "title": "AI summary of each change",
            "type": "boolean",
            "description": "For significant changes, add aiSummary (what changed, in one or two sentences) and significance (1 trivial to 5 critical), also included in alerts. Charged per summary.",
            "default": false
          },
          "baselineMode": {
            "title": "Compare with",
            "enum": [
              "rolling",
              "locked"
            ],
            "type": "string",
            "description": "Locked: every run compares with the approved version saved on the first run (compliance use), and alerts fire only when the page differs from what the previous run saw. Values: rolling = The previous check (default); locked = A locked baseline (the first check, until you reset it).",
            "default": "rolling"
          },
          "resetBaseline": {
            "title": "Reset the baseline now",
            "type": "boolean",
            "description": "Save the current version as the new baseline in this run (reports first-check).",
            "default": false
          },
          "url": {
            "title": "URL (Content Checker compatible)",
            "type": "string",
            "description": "Same as adding one page to \"Pages to watch\". Accepted so Content Checker inputs work unchanged."
          },
          "contentSelector": {
            "title": "Content selector (Content Checker compatible)",
            "type": "string",
            "description": "Same as \"Only watch this part of the page\"."
          },
          "sendNotificationTo": {
            "title": "Send notification to (Content Checker compatible)",
            "type": "string",
            "description": "Same as \"E-mail changes to\"."
          },
          "screenshotSelector": {
            "title": "Screenshot selector (Content Checker compatible)",
            "type": "string",
            "description": "Same as a screenshot of this element. Setting it turns on \"Screenshot changed pages\" (charged per screenshot), as in Content Checker."
          },
          "informOnError": {
            "title": "Notification in case of error (Content Checker compatible)",
            "type": "string",
            "description": "\"true\" = same as \"Alert when a page keeps failing\" with an alert after the first failure (unless you set the number of failures)."
          },
          "httpVia": {
            "title": "Plain HTTP requests from",
            "enum": [
              "auto",
              "backend",
              "direct",
              "vm"
            ],
            "type": "string",
            "description": "Some sites block requests from data centers. Auto retries from a second network before falling back to a real browser. If both are refused, Auto also tries our second server (Oracle, different IP) before a real browser.",
            "default": "auto"
          },
          "proxyConfiguration": {
            "title": "Proxy (optional)",
            "type": "object",
            "description": "Only used for requests sent from Apify's network. Apify proxy usage is billed to your Apify account."
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}