{ "variable": [ { "id": "baseUrl", "key": "baseUrl", "type": "string", "name": "string", "value": "https:\/\/api.webchangedetector.com\/" } ], "info": { "name": "WebChange Detector", "_postman_id": "0d002021-5787-438a-a601-023348fb0b2d", "description": "This documentation aims to provide you with all the information you need to integrate WebChange Detector into your workflow.", "schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.1.0\/collection.json" }, "item": [ { "name": "AI Feedback Rules", "description": "Manage rules for ignoring recurring false positives in AI verification results.", "item": [ { "name": "List AI Feedback Rules", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/ai-feedback-rules", "query": [ { "key": "scope", "value": "url", "description": "Filter by scope.", "disabled": false }, { "key": "is_active", "value": "1", "description": "Filter by active status.", "disabled": false }, { "key": "website_id", "value": "21cf8800-f906-4fa3-b1db-ed3d2977354d", "description": "Filter by website UUID.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v2\/ai-feedback-rules?scope=url&is_active=1&website_id=21cf8800-f906-4fa3-b1db-ed3d2977354d" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a paginated list of all `AiFeedbackRule` for the current user." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"21cf8800-f906-4fa3-b1db-ed3d2977354d\",\"scope\":\"url\",\"description\":\"Slider showing different slide\",\"region_context\":{\"bbox\":{\"x\":0,\"y\":100,\"w\":1920,\"h\":300}},\"is_active\":true,\"last_matched_at\":null,\"match_count\":0,\"url_id\":\"418e0748-a9cf-480b-86d6-88b00bac00b9\",\"group_id\":null,\"website_id\":null,\"created_at\":\"2026-02-21 13:37:00\",\"updated_at\":\"2026-02-21 13:37:00\"}]}", "name": "" } ] }, { "name": "Create AI Feedback Rule", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/ai-feedback-rules", "query": [], "raw": "{{baseUrl}}\/api\/v2\/ai-feedback-rules" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"type\":\"visual\",\"comparison_id\":\"21cf8800-f906-4fa3-b1db-ed3d2977354d\",\"region_id\":0,\"console_entry\":\"[Vue warn]: Component is missing template or render function.\",\"scope\":\"url\"}" }, "description": "Creates a new `AiFeedbackRule` from a comparison region. The backend\nauto-resolves whether the group belongs to a website and sets the\nscope accordingly." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"21cf8800-f906-4fa3-b1db-ed3d2977354d\",\"scope\":\"url\",\"description\":\"Slider showing different slide\",\"region_context\":{\"bbox\":{\"x\":0,\"y\":100,\"w\":1920,\"h\":300}},\"is_active\":true,\"last_matched_at\":null,\"match_count\":0,\"url_id\":\"418e0748-a9cf-480b-86d6-88b00bac00b9\",\"group_id\":null,\"website_id\":null,\"created_at\":\"2026-02-21 13:37:00\",\"updated_at\":\"2026-02-21 13:37:00\"}}", "name": "" } ] }, { "name": "Update AI Feedback Rule", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/ai-feedback-rules\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v2\/ai-feedback-rules\/:id", "variable": [ { "id": "id", "key": "id", "value": "non", "description": "The ID of the ai feedback rule." }, { "id": "ai_feedback_rule", "key": "ai_feedback_rule", "value": "21cf8800-f906-4fa3-b1db-ed3d2977354d", "description": "The UUID of the AI Feedback Rule." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"is_active\":false,\"scope\":\"url\"}" }, "description": "Update the active status and\/or scope of an `AiFeedbackRule`." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"21cf8800-f906-4fa3-b1db-ed3d2977354d\",\"scope\":\"url\",\"description\":\"Slider showing different slide\",\"region_context\":null,\"is_active\":false,\"last_matched_at\":null,\"match_count\":0,\"url_id\":\"418e0748-a9cf-480b-86d6-88b00bac00b9\",\"group_id\":null,\"website_id\":null,\"created_at\":\"2026-02-21 13:37:00\",\"updated_at\":\"2026-02-21 13:37:00\"}}", "name": "" } ] }, { "name": "Delete AI Feedback Rule", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/ai-feedback-rules\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v2\/ai-feedback-rules\/:id", "variable": [ { "id": "id", "key": "id", "value": "molestias", "description": "The ID of the ai feedback rule." }, { "id": "ai_feedback_rule", "key": "ai_feedback_rule", "value": "21cf8800-f906-4fa3-b1db-ed3d2977354d", "description": "The UUID of the AI Feedback Rule." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Permanently deletes an `AiFeedbackRule`." }, "response": [] } ] }, { "name": "Account", "description": "This object represents your account with WCD", "item": [ { "name": "Get Account", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/account", "query": [], "raw": "{{baseUrl}}\/api\/v2\/account" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieves your Account. The fields `plan`, `plan_name`, `company` and `magic_login_secret` only come for full accounts (not sub accounts)." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"041c6528-783f-4e7e-b831-1a424ffeb8f3\",\"name_first\":\"Hans\",\"name_last\":\"Hacker\",\"email\":\"mail@example.com\",\"webhook_secret\":\"zq3csqdst0txgo5qe9mkqsourrxo56wd\",\"is_subaccount\":false,\"account_level\":0,\"can_manage_subaccounts\":false,\"can_create_subaccounts\":false,\"plan_label\":null,\"invitation_accepted\":true,\"plan_features\":{\"ai_verification\":true,\"browser_console\":true},\"checks_done\":6982,\"checks_left\":3018,\"checks_limit\":10000,\"timezone\":\"UTC\",\"status\":\"active\",\"renewal_at\":\"2025-01-01 13:37:42\",\"plan\":\"agency\",\"plan_name\":\"Agency\",\"company\":\"ACME Ltd\",\"magic_login_secret\":\"WdKnLLcsDxpJdfmv\"}}", "name": "" } ] }, { "name": "Update Account", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/account", "query": [], "raw": "{{baseUrl}}\/api\/v2\/account" }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name_first\":\"Jane\",\"name_last\":\"Doe\",\"company\":\"ACME LLC\"}" }, "description": "Updates your `Account` by setting the values of the parameters passed.\nAny parameters not provided will be left unchanged." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"041c6528-783f-4e7e-b831-1a424ffeb8f3\",\"name_first\":\"Jane\",\"name_last\":\"Doe\",\"email\":\"mail@example.com\",\"webhook_secret\":\"zq3csqdst0txgo5qe9mkqsourrxo56wd\",\"is_subaccount\":false,\"account_level\":0,\"can_manage_subaccounts\":false,\"can_create_subaccounts\":false,\"plan_label\":null,\"invitation_accepted\":true,\"plan_features\":{\"ai_verification\":true,\"browser_console\":true},\"checks_done\":42,\"checks_left\":1337,\"checks_limit\":1379,\"timezone\":\"UTC\",\"status\":\"active\",\"renewal_at\":\"2025-01-01 13:37:42\",\"plan\":\"agency\",\"plan_name\":\"Agency\",\"company\":\"ACME LLC\",\"magic_login_secret\":\"WdKnLLcsDxpJdfmv\"}}", "name": "" } ] }, { "name": "Get Account Stats", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/account\/stats", "query": [], "raw": "{{baseUrl}}\/api\/v2\/account\/stats" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns aggregated statistics for the authenticated account, computed across\nALL groups and websites (not paginated).\n\n- `estimated_monthly_checks` (top-level): estimated monthly monitoring checks. Kept for backwards compatibility.\n- `monitoring`: enabled monitoring groups; website\/url counts, monthly estimate, soonest next run.\n- `manual`: enabled manual (non-monitoring) groups with selected URLs; website\/url counts and checks per run.\n- `auto_update`: websites with auto-update checks enabled; count, missing-email count, active weekdays, monthly forecast." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"estimated_monthly_checks\":4520,\"monitoring\":{\"websites\":12,\"urls\":84,\"estimated_monthly_checks\":4520,\"next_run_at\":1716900000,\"next_runs\":[{\"name\":\"example.com\",\"domain\":\"example.com\",\"next_run_at\":1716900000},{\"name\":\"shop.example\",\"domain\":\"shop.example\",\"next_run_at\":1716903600}],\"trigger_websites\":1},\"manual\":{\"websites\":8,\"urls\":56,\"checks_per_run\":112},\"auto_update\":{\"websites_enabled\":9,\"missing_email\":1,\"active_weekdays\":[\"Mon\",\"Wed\",\"Fri\"],\"estimated_monthly_checks\":1947,\"next_runs\":[{\"name\":\"example.com\",\"domain\":\"example.com\",\"next_run_at\":1716900000},{\"name\":\"shop.example\",\"domain\":\"shop.example\",\"next_run_at\":1716986400}]}}}", "name": "" } ] }, { "name": "Reactivate Account", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/account\/reactivate", "query": [], "raw": "{{baseUrl}}\/api\/v2\/account\/reactivate" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Re-activates an account that was paused due to inactivity, including all its subaccounts.\nOnly the account owner can re-activate; cancelled accounts cannot be re-activated this way." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"041c6528-783f-4e7e-b831-1a424ffeb8f3\",\"name_first\":\"Hans\",\"name_last\":\"Hacker\",\"email\":\"mail@example.com\",\"status\":\"active\",\"renewal_at\":\"2025-01-01 13:37:42\"}}", "name": "" } ] } ] }, { "name": "Batch", "description": "This object represents Batches of Queues.", "item": [ { "name": "List Batches", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/batches", "query": [ { "key": "above_threshold", "value": "", "description": "Only show Batches where there is a change detected between 2 screenshots.", "disabled": true }, { "key": "from", "value": "2024-07-01", "description": "Start date for filter. Must be a valid date.", "disabled": false }, { "key": "to", "value": "2024-07-04", "description": "End date for filter, defaults to today. Must be a valid date.", "disabled": false }, { "key": "status", "value": "to_fix,false_positive", "description": "Comma separated list of Comparison status to filter for.", "disabled": false }, { "key": "queue_type", "value": "post,comparison", "description": "Comma separated list of Queue types to filter for.", "disabled": false }, { "key": "group_ids", "value": "023c282c-6513-420a-a36b-a654312ab229,023c282c-6513-420a-a36b-a654312ab230", "description": "Comma separated list of Group IDs.", "disabled": false }, { "key": "urls", "value": "023c282c-6513-420a-a36b-a654312ab229", "description": "Comma separated list of URL IDs to filter for.", "disabled": false }, { "key": "websites", "value": "023c282c-6513-420a-a36b-a654312ab229", "description": "Comma separated list of Website IDs to filter for.", "disabled": false }, { "key": "source", "value": "manual,auto_update", "description": "Comma separated list of Batch sources to filter for (manual, monitoring, auto_update).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v2\/batches?above_threshold=&from=2024-07-01&to=2024-07-04&status=to_fix%2Cfalse_positive&queue_type=post%2Ccomparison&group_ids=023c282c-6513-420a-a36b-a654312ab229%2C023c282c-6513-420a-a36b-a654312ab230&urls=023c282c-6513-420a-a36b-a654312ab229&websites=023c282c-6513-420a-a36b-a654312ab229&source=manual%2Cauto_update" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a list of all `Batch`. The `Batches` are sorted by creation date, with\nthe most recent `Batches` appearing first.\n\n`source` is one of `manual`, `monitoring`, `auto_update`. `ai_summary` is `null` for accounts without the `ai-verification` feature; `ai_summary.overall_status` is one of `everything_ok`, `needs_attention`. `website_domains` lists the unique domains of the websites linked to the batch's queue groups (empty when no website is linked).\n\n`trigger_context` is set for trigger-based monitoring runs (`source` = `monitoring`, started e.g. by saving a post in WordPress) and `null` otherwise. It holds the trigger `type`, `first_triggered_at` and the checked `pages`; each page has its `url` and `triggered_at`, plus `title`, `post_id` and `editor` when the trigger reported them. `type` is `post_save` or `manual_trigger` (\"run monitoring now\"). A `manual_trigger` run also has `scope` (`url` or `all`) and `editor` when reported; with `scope` = `all` (the whole Group) `pages` is empty." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"0d5f8108-51f1-4961-939a-2d33c7145918\",\"name\":\"Monitoring\",\"source\":\"monitoring\",\"trigger_context\":{\"type\":\"post_save\",\"first_triggered_at\":\"2024-07-29T13:30:12+00:00\",\"pages\":[{\"url\":\"example.com\\\/about\",\"title\":\"About us\",\"post_id\":42,\"editor\":\"Anna\",\"triggered_at\":\"2024-07-29T13:31:05+00:00\"}]},\"group_names\":[\"example.com - Monitoring Checks\"],\"website_domains\":[\"example.com\"],\"sc_version\":\"2.0\",\"finished_at\":\"2024-07-29 13:37:42\",\"ai_summary\":{\"summary\":\"Pricing text updated and navigation menu restructured. New JS error on checkout may affect functionality.\",\"overall_status\":\"needs_attention\",\"processing_time_ms\":1234},\"update_results\":null,\"comparisons_count\":{\"ok\":0,\"new\":1,\"false_positive\":0,\"to_fix\":0,\"above_threshold\":10},\"queues_count\":{\"failed\":0},\"browser_console_count\":{\"added\":1,\"removed\":0,\"mixed\":0,\"unchanged\":0}}],\"links\":{\"first\":\"http:\\\/\\\/api.webchangedetector.test\\\/api\\\/v2\\\/batches?page=1\",\"last\":\"http:\\\/\\\/api.webchangedetector.test\\\/api\\\/v2\\\/batches?page=1\",\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Previous\",\"active\":false},{\"url\":\"http:\\\/\\\/api.webchangedetector.test\\\/api\\\/v2\\\/batches?page=1\",\"label\":\"1\",\"active\":true},{\"url\":null,\"label\":\"Next »\",\"active\":false}],\"path\":\"http:\\\/\\\/api.webchangedetector.test\\\/api\\\/v2\\\/batches\",\"per_page\":15,\"to\":1,\"total\":1}}", "name": "" } ] }, { "name": "Get Batch", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/batches\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v2\/batches\/:id", "variable": [ { "id": "id", "key": "id", "value": "0d5f8108-51f1-4961-939a-2d33c7145918", "description": "The ID of the Batch." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieves a `Batch` object identfied by their ID.\n\n`source` is one of `manual`, `monitoring`, `auto_update`. `ai_summary` is `null` for accounts without the `ai-verification` feature; `ai_summary.overall_status` is one of `everything_ok`, `needs_attention`. `website_domains` lists the unique domains of the websites linked to the batch's queue groups (empty when no website is linked). `trigger_context` is set for trigger-based monitoring runs and `null` otherwise (shape: see List Batches)." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"0d5f8108-51f1-4961-939a-2d33c7145918\",\"name\":\"Foobar\",\"source\":\"monitoring\",\"trigger_context\":null,\"group_names\":[\"example.com - Monitoring Checks\"],\"website_domains\":[\"example.com\"],\"sc_version\":\"2.0\",\"finished_at\":\"2024-07-29 13:37:42\",\"ai_summary\":{\"summary\":\"Pricing text updated and navigation menu restructured. New JS error on checkout may affect functionality.\",\"overall_status\":\"needs_attention\",\"processing_time_ms\":1234},\"update_results\":null,\"comparisons_count\":{\"ok\":0,\"new\":1,\"false_positive\":0,\"to_fix\":0,\"above_threshold\":10},\"queues_count\":{\"failed\":0},\"browser_console_count\":{\"added\":1,\"removed\":0,\"mixed\":0,\"unchanged\":0}}}", "name": "" } ] }, { "name": "Update Batch", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/batches\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v2\/batches\/:id", "variable": [ { "id": "id", "key": "id", "value": "0d5f8108-51f1-4961-939a-2d33c7145918", "description": "The ID of the Batch." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Foobar\"}" }, "description": "Updates the specified `Batch` by setting the values of the parameters passed.\nAny parameters not provided will be left unchanged." }, "response": [ { "header": [], "code": 200, "body": "{\"id\":\"0d5f8108-51f1-4961-939a-2d33c7145918\",\"name\":\"Foobar\",\"source\":\"monitoring\",\"trigger_context\":null,\"group_names\":[\"example.com - Monitoring Checks\"],\"website_domains\":[\"example.com\"],\"sc_version\":\"2.0\",\"finished_at\":\"2024-07-29 13:37:42\",\"ai_summary\":{\"summary\":\"Pricing text updated and navigation menu restructured. New JS error on checkout may affect functionality.\",\"overall_status\":\"needs_attention\",\"processing_time_ms\":1234},\"update_results\":null,\"comparisons_count\":{\"ok\":0,\"new\":1,\"false_positive\":0,\"to_fix\":0,\"above_threshold\":10},\"queues_count\":{\"failed\":0},\"browser_console_count\":{\"added\":1,\"removed\":0,\"mixed\":0,\"unchanged\":0}}", "name": "" } ] }, { "name": "Store Batch Update Results", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/batches\/:id\/update-results", "query": [], "raw": "{{baseUrl}}\/api\/v2\/batches\/:id\/update-results", "variable": [ { "id": "id", "key": "id", "value": "0d5f8108-51f1-4961-939a-2d33c7145918", "description": "The ID of the Batch." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"timestamp\":1756800000,\"updates\":{\"core\":{\"attempted\":false,\"success\":false,\"from_version\":\"ffedwkwaviftjjugsevy\",\"to_version\":\"ngbutgcc\",\"error\":\"onwobjtqxd\",\"messages\":[\"fxmfjvovmwwgkmvimwsrikts\"]},\"plugins\":[{\"slug\":\"dioytihgpxcueki\",\"name\":\"w\",\"from_version\":\"llevbfamjmfjgeajjecno\",\"to_version\":\"tswjaujzraupjyzwjqccz\",\"success\":false,\"error\":\"dafzfdvqazwrdxsczvjxppxaq\",\"messages\":[\"zdpdgymqmglrxcycatkpaa\"]}],\"themes\":[{\"slug\":\"ev\",\"name\":\"xwczqwluaphhvhqc\",\"from_version\":\"dudfnxlnvxfk\",\"to_version\":\"qkadabvgwismyieqwbwf\",\"success\":false,\"error\":\"ybatabyimucfpdisbhjrtpogs\",\"messages\":[\"ipvptwwwu\"]}]},\"summary\":{\"total_attempted\":40,\"successful\":23,\"failed\":8,\"status\":\"completed\"}}" }, "description": "Stores the WordPress update results (core \/ plugins \/ themes) that were applied\naround this `Batch`. The whole blob is replaced on every call, so the endpoint is\nidempotent and safe to retry.\n\nIt is accepted in ANY batch state (also while the batch is still running) and for\nANY `source`. Send it for an empty run too (`updates.core` = `null`, empty arrays,\n`summary.total_attempted` = `0`, `summary.status` = `completed`).\n\nFor a batch with `source` = `auto_update` this is what enables the Auto Update Check\nresult email: it is sent once the batch is finished AND the update results are stored,\nwhichever of the two happens last." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"0d5f8108-51f1-4961-939a-2d33c7145918\",\"name\":\"Auto Update Checks\",\"source\":\"auto_update\",\"trigger_context\":null,\"group_names\":[\"example.com - On-Demand Checks\"],\"website_domains\":[\"example.com\"],\"sc_version\":\"2.0\",\"finished_at\":\"2024-07-29 13:37:42\",\"ai_summary\":null,\"update_results\":{\"timestamp\":1756800000,\"updates\":{\"core\":null,\"plugins\":[{\"slug\":\"akismet\",\"name\":\"Akismet Anti-Spam\",\"from_version\":\"5.3\",\"to_version\":\"5.3.1\",\"success\":true,\"error\":null,\"messages\":[]}],\"themes\":[]},\"summary\":{\"total_attempted\":1,\"successful\":1,\"failed\":0,\"status\":\"completed\"}},\"comparisons_count\":{\"ok\":0,\"new\":1,\"false_positive\":0,\"to_fix\":0,\"above_threshold\":10},\"queues_count\":{\"failed\":0},\"browser_console_count\":{\"added\":1,\"removed\":0,\"mixed\":0,\"unchanged\":0}}}", "name": "" } ] } ] }, { "name": "Comparison", "description": "This object represents the comparison between 2 `Screenshots` and how they differ.", "item": [ { "name": "List Comparisons", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/comparisons", "query": [ { "key": "above_threshold", "value": "", "description": "Is a change detected between 2 screenshots.", "disabled": true }, { "key": "from", "value": "2024-07-01", "description": "Start date for filter. Must be a valid date.", "disabled": false }, { "key": "to", "value": "2024-07-04", "description": "End date for filter, defaults to today. Must be a valid date.", "disabled": false }, { "key": "status", "value": "to_fix,false_positive", "description": "Comma separated list of status to filter for.", "disabled": false }, { "key": "groups", "value": "023c282c-6513-420a-a36b-a654312ab229,023c282c-6513-420a-a36b-a654312ab230", "description": "Comma separated list of group IDs.", "disabled": false }, { "key": "batches", "value": "0d5f8108-51f1-4961-939a-2d33c7145918,1d5f8108-51f1-4961-939a-2d33c7145918", "description": "Batch IDs.", "disabled": false }, { "key": "token", "value": "autem", "description": "", "disabled": false }, { "key": "urls", "value": "023c282c-6513-420a-a36b-a654312ab229", "description": "Comma separated list of URL UUIDs.", "disabled": false }, { "key": "websites", "value": "023c282c-6513-420a-a36b-a654312ab229", "description": "Comma separated list of Website UUIDs.", "disabled": false }, { "key": "source", "value": "manual,auto_update", "description": "Comma separated list of Batch sources to filter for (manual, monitoring, auto_update).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v2\/comparisons?above_threshold=&from=2024-07-01&to=2024-07-04&status=to_fix%2Cfalse_positive&groups=023c282c-6513-420a-a36b-a654312ab229%2C023c282c-6513-420a-a36b-a654312ab230&batches=0d5f8108-51f1-4961-939a-2d33c7145918%2C1d5f8108-51f1-4961-939a-2d33c7145918&token=autem&urls=023c282c-6513-420a-a36b-a654312ab229&websites=023c282c-6513-420a-a36b-a654312ab229&source=manual%2Cauto_update" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a list of all `Comparison`. The `Comparisons` are sorted by creation date, with\nthe most recent `Comparisons` appearing first.\n\n`batch_source` is one of `manual`, `monitoring`, `auto_update`. `batch_trigger_type` is `post_save` (a saved page started the monitoring run), `manual_trigger` (\"run monitoring now\") or `null` (scheduled monitoring and all non-monitoring runs). `browser_console_*` fields are `null` unless the account has the `browser-console-comparisons` feature. `ai_regions`, `ai_verification_status`, and `ai_verification_result` are `null` unless the account has the `ai-verification` feature; `ai_verification_status` is one of `pending`, `verified`, `failed`, `skipped`. A comparison whose before or after screenshot came back as a completely blank page is decided automatically, without AI analysis: it carries an `ai_verification_result` with the marker `capture_issue` (`after_blank`, `before_blank` or `both_blank`), a `summary` and `alerts`, and no `regions`. Only `after_blank` (the page went blank) is an alert: it sets `status = new` and `alerts = 1`. A page recovering (`before_blank`) or staying blank (`both_blank`) is recorded the same way but resolves to `status = ok` with `alerts = 0`, because there is no valid comparison to judge against a blank baseline." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"21cf8800-f906-4fa3-b1db-ed3d2977354d\",\"screenshot_1\":\"958dce2c-8468-47d3-8bc2-7dc6bf0aadae\",\"screenshot_1_created_at\":\"2025-01-01 13:37:00\",\"screenshot_1_updated_at\":\"2025-01-01 13:37:01\",\"screenshot_1_link\":\"https:\\\/\\\/storage.webchangedetector.com\\\/folder\\\/screenshot1.png\",\"screenshot_2\":\"958dce2c-8468-47d3-8bc2-7dc6bf0aadaf\",\"screenshot_2_created_at\":\"2025-01-01 13:37:00\",\"screenshot_2_updated_at\":\"2025-01-01 13:37:01\",\"screenshot_2_link\":\"https:\\\/\\\/storage.webchangedetector.com\\\/folder\\\/screenshot2.png\",\"html_title\":\"Foobar\",\"device\":\"mobile\",\"monitoring\":true,\"group\":\"023c282c-6513-420a-a36b-a654312ab229\",\"group_name\":\"Barfoo\",\"queue\":\"8ea7b88d-b5c6-4fad-8e9d-1497a54d9266\",\"link\":\"https:\\\/\\\/storage.webchangedetector.com\\\/folder\\\/comparison.png\",\"batch\":\"0d5f8108-51f1-4961-939a-2d33c7145918\",\"batch_name\":\"Auto Update Checks\",\"batch_source\":\"monitoring\",\"batch_trigger_type\":null,\"difference_percent\":0.4,\"threshold\":0.2,\"status\":\"new\",\"public_link\":\"https:\\\/\\\/www.webchangedetector.com\\\/show-change-detection?token=f00b4r\",\"token\":\"f00b4r\",\"url\":\"https:\\\/\\\/example.com\",\"url_id\":\"418e0748-a9cf-480b-86d6-88b00bac00b9\",\"cms\":\"wordpress\",\"browser_console_added\":null,\"browser_console_removed\":null,\"browser_console_change\":null,\"ai_regions\":[{\"id\":0,\"bbox\":{\"x\":120,\"y\":340,\"w\":280,\"h\":64},\"pixel_count\":1840}],\"ai_verification_status\":\"verified\",\"ai_verification_result\":{\"capture_issue\":null,\"summary\":\"Pricing text updated, may need review.\",\"processing_time_ms\":1234,\"total_regions\":1,\"all_good\":0,\"not_sure\":0,\"alerts\":1,\"regions\":[{\"region_id\":0,\"category\":\"alert\",\"description\":\"Pricing changed from $9 to $12\",\"confidence\":0.92,\"reason\":\"Numeric price text changed in hero section\",\"matched_feedback_rule\":null}],\"console_analysis\":null},\"created_at\":\"2025-01-01 13:37:00\"}],\"links\":{\"first\":\"http:\\\/\\\/api.webchangedetector.test\\\/api\\\/v2\\\/comparisons?page=1\",\"last\":\"http:\\\/\\\/api.webchangedetector.test\\\/api\\\/v2\\\/comparisons?page=1\",\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Previous\",\"active\":false},{\"url\":\"http:\\\/\\\/api.webchangedetector.test\\\/api\\\/v2\\\/comparisons?page=1\",\"label\":\"1\",\"active\":true},{\"url\":null,\"label\":\"Next »\",\"active\":false}],\"path\":\"http:\\\/\\\/api.webchangedetector.test\\\/api\\\/v2\\\/comparisons\",\"per_page\":15,\"to\":1,\"total\":1,\"above_threshold_count\":3}}", "name": "" } ] }, { "name": "Get Comparison", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/comparisons\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v2\/comparisons\/:id", "variable": [ { "id": "id", "key": "id", "value": "21cf8800-f906-4fa3-b1db-ed3d2977354d", "description": "The ID of the Comparison." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieves a `Comparison` object identfied by their ID.\n\n`batch_source` is one of `manual`, `monitoring`, `auto_update`. `batch_trigger_type` is `post_save` (a saved page started the monitoring run), `manual_trigger` (\"run monitoring now\") or `null` (scheduled monitoring and all non-monitoring runs). `browser_console_*` fields are `null` unless the account has the `browser-console-comparisons` feature. `ai_regions`, `ai_verification_status`, and `ai_verification_result` are `null` unless the account has the `ai-verification` feature; `ai_verification_status` is one of `pending`, `verified`, `failed`, `skipped`. A comparison whose before or after screenshot came back as a completely blank page is decided automatically, without AI analysis: it carries an `ai_verification_result` with the marker `capture_issue` (`after_blank`, `before_blank` or `both_blank`), a `summary` and `alerts`, and no `regions`. Only `after_blank` (the page went blank) is an alert: it sets `status = new` and `alerts = 1`. A page recovering (`before_blank`) or staying blank (`both_blank`) is recorded the same way but resolves to `status = ok` with `alerts = 0`, because there is no valid comparison to judge against a blank baseline." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"21cf8800-f906-4fa3-b1db-ed3d2977354d\",\"screenshot_1\":\"958dce2c-8468-47d3-8bc2-7dc6bf0aadae\",\"screenshot_1_created_at\":\"2025-01-01 13:37:00\",\"screenshot_1_updated_at\":\"2025-01-01 13:37:01\",\"screenshot_1_link\":\"https:\\\/\\\/storage.webchangedetector.com\\\/folder\\\/screenshot1.png\",\"screenshot_2\":\"958dce2c-8468-47d3-8bc2-7dc6bf0aadaf\",\"screenshot_2_created_at\":\"2025-01-01 13:37:00\",\"screenshot_2_updated_at\":\"2025-01-01 13:37:01\",\"screenshot_2_link\":\"https:\\\/\\\/storage.webchangedetector.com\\\/folder\\\/screenshot2.png\",\"html_title\":\"Foobar\",\"device\":\"mobile\",\"monitoring\":true,\"group\":\"023c282c-6513-420a-a36b-a654312ab229\",\"group_name\":\"Barfoo\",\"queue\":\"8ea7b88d-b5c6-4fad-8e9d-1497a54d9266\",\"link\":\"https:\\\/\\\/storage.webchangedetector.com\\\/folder\\\/comparison.png\",\"batch\":\"0d5f8108-51f1-4961-939a-2d33c7145918\",\"batch_name\":\"Auto Update Checks\",\"batch_source\":\"monitoring\",\"batch_trigger_type\":null,\"difference_percent\":0.4,\"threshold\":0.2,\"status\":\"new\",\"public_link\":\"https:\\\/\\\/www.webchangedetector.com\\\/show-change-detection?token=f00b4r\",\"token\":\"f00b4r\",\"url\":\"https:\\\/\\\/example.com\",\"url_id\":\"418e0748-a9cf-480b-86d6-88b00bac00b9\",\"cms\":\"wordpress\",\"browser_console_added\":null,\"browser_console_removed\":null,\"browser_console_change\":null,\"ai_regions\":[{\"id\":0,\"bbox\":{\"x\":120,\"y\":340,\"w\":280,\"h\":64},\"pixel_count\":1840}],\"ai_verification_status\":\"verified\",\"ai_verification_result\":{\"capture_issue\":null,\"summary\":\"Pricing text updated, may need review.\",\"processing_time_ms\":1234,\"total_regions\":1,\"all_good\":0,\"not_sure\":0,\"alerts\":1,\"regions\":[{\"region_id\":0,\"category\":\"alert\",\"description\":\"Pricing changed from $9 to $12\",\"confidence\":0.92,\"reason\":\"Numeric price text changed in hero section\",\"matched_feedback_rule\":null}],\"console_analysis\":null},\"created_at\":\"2025-01-01 13:37:00\"}}", "name": "" } ] }, { "name": "Update Comparison", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/comparisons\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v2\/comparisons\/:id", "variable": [ { "id": "id", "key": "id", "value": "21cf8800-f906-4fa3-b1db-ed3d2977354d", "description": "The ID of the Comparison." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"status\":\"false_positive\"}" }, "description": "Updates the specified `Comparison` by setting the values of the parameters passed.\nAny parameters not provided will be left unchanged.\n\n`batch_source` is one of `manual`, `monitoring`, `auto_update`. `batch_trigger_type` is `post_save` (a saved page started the monitoring run), `manual_trigger` (\"run monitoring now\") or `null` (scheduled monitoring and all non-monitoring runs). `browser_console_*` fields are `null` unless the account has the `browser-console-comparisons` feature. `ai_regions`, `ai_verification_status`, and `ai_verification_result` are `null` unless the account has the `ai-verification` feature; `ai_verification_status` is one of `pending`, `verified`, `failed`, `skipped`. A comparison whose before or after screenshot came back as a completely blank page is decided automatically, without AI analysis: it carries an `ai_verification_result` with the marker `capture_issue` (`after_blank`, `before_blank` or `both_blank`), a `summary` and `alerts`, and no `regions`. Only `after_blank` (the page went blank) is an alert: it sets `status = new` and `alerts = 1`. A page recovering (`before_blank`) or staying blank (`both_blank`) is recorded the same way but resolves to `status = ok` with `alerts = 0`, because there is no valid comparison to judge against a blank baseline." }, "response": [ { "header": [], "code": 200, "body": "{\"id\":\"21cf8800-f906-4fa3-b1db-ed3d2977354d\",\"screenshot_1\":\"958dce2c-8468-47d3-8bc2-7dc6bf0aadae\",\"screenshot_1_created_at\":\"2025-01-01 13:37:00\",\"screenshot_1_updated_at\":\"2025-01-01 13:37:01\",\"screenshot_1_link\":\"https:\\\/\\\/storage.webchangedetector.com\\\/folder\\\/screenshot1.png\",\"screenshot_2\":\"958dce2c-8468-47d3-8bc2-7dc6bf0aadaf\",\"screenshot_2_created_at\":\"2025-01-01 13:37:00\",\"screenshot_2_updated_at\":\"2025-01-01 13:37:01\",\"screenshot_2_link\":\"https:\\\/\\\/storage.webchangedetector.com\\\/folder\\\/screenshot2.png\",\"html_title\":\"Foobar\",\"device\":\"mobile\",\"monitoring\":true,\"group\":\"023c282c-6513-420a-a36b-a654312ab229\",\"group_name\":\"Barfoo\",\"queue\":\"8ea7b88d-b5c6-4fad-8e9d-1497a54d9266\",\"link\":\"https:\\\/\\\/storage.webchangedetector.com\\\/folder\\\/comparison.png\",\"batch\":\"0d5f8108-51f1-4961-939a-2d33c7145918\",\"batch_name\":\"Auto Update Checks\",\"batch_source\":\"monitoring\",\"batch_trigger_type\":null,\"difference_percent\":0.4,\"threshold\":0.2,\"status\":\"new\",\"public_link\":\"https:\\\/\\\/www.webchangedetector.com\\\/show-change-detection?token=f00b4r\",\"token\":\"f00b4r\",\"url\":\"https:\\\/\\\/example.com\",\"url_id\":\"418e0748-a9cf-480b-86d6-88b00bac00b9\",\"cms\":\"wordpress\",\"browser_console_added\":null,\"browser_console_removed\":null,\"browser_console_change\":null,\"ai_regions\":[{\"id\":0,\"bbox\":{\"x\":120,\"y\":340,\"w\":280,\"h\":64},\"pixel_count\":1840}],\"ai_verification_status\":\"verified\",\"ai_verification_result\":{\"capture_issue\":null,\"summary\":\"Pricing text updated, may need review.\",\"processing_time_ms\":1234,\"total_regions\":1,\"all_good\":0,\"not_sure\":0,\"alerts\":1,\"regions\":[{\"region_id\":0,\"category\":\"alert\",\"description\":\"Pricing changed from $9 to $12\",\"confidence\":0.92,\"reason\":\"Numeric price text changed in hero section\",\"matched_feedback_rule\":null}],\"console_analysis\":null},\"created_at\":\"2025-01-01 13:37:00\"}", "name": "" } ] } ] }, { "name": "Group", "description": "This object groups together a list of URLs and group wide settings for them.", "item": [ { "name": "List Groups", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/groups", "query": [ { "key": "per_page", "value": "15", "description": "Maximum number of Groups per page.", "disabled": false }, { "key": "monitoring", "value": "1", "description": "Filter to monitoring (`true`) or manual-checks (`false`) groups only. Omit to return both.", "disabled": false }, { "key": "ids[0]", "value": "autem", "description": "", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v2\/groups?per_page=15&monitoring=1&ids%5B0%5D=autem" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a list of all Groups. The Groups are sorted by creation date, with\nthe most recent Groups appearing first." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"023c282c-6513-420a-a36b-a654312ab229\",\"name\":\"Example Group\",\"monitoring\":true,\"enabled\":true,\"hour_of_day\":0,\"interval_in_h\":24,\"alert_emails\":\"hello@example.com,test@foobar.com\",\"css\":null,\"js\":null,\"cms\":\"wordpress\",\"threshold\":0.2,\"urls_count\":42,\"selected_urls_count\":37,\"basic_auth_user\":null,\"has_basic_auth\":false,\"proxy_type\":\"none\",\"proxy_country\":\"us\"}],\"links\":{\"first\":\"http:\\\/\\\/api.webchangedetector.test\\\/api\\\/v2\\\/groups?page=1\",\"last\":\"http:\\\/\\\/api.webchangedetector.test\\\/api\\\/v2\\\/groups?page=1\",\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Previous\",\"active\":false},{\"url\":\"http:\\\/\\\/api.webchangedetector.test\\\/api\\\/v2\\\/groups?page=1\",\"label\":\"1\",\"active\":true},{\"url\":null,\"label\":\"Next »\",\"active\":false}],\"path\":\"http:\\\/\\\/api.webchangedetector.test\\\/api\\\/v2\\\/groups\",\"per_page\":15,\"to\":1,\"total\":1}}", "name": "" } ] }, { "name": "Create Group", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/groups", "query": [], "raw": "{{baseUrl}}\/api\/v2\/groups" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Example Group\",\"monitoring\":true,\"enabled\":true,\"hour_of_day\":0,\"interval_in_h\":24,\"schedule_type\":\"interval\",\"schedule_days\":[1,3,5],\"quiet_hours_start\":22,\"quiet_hours_end\":6,\"alert_emails\":[\"hello@example.com\",\"mail@example.com\"],\"cms\":\"wordpress\",\"basic_auth_user\":\"admin\",\"basic_auth_password\":\"secret123\",\"proxy_type\":\"none\",\"proxy_country\":\"enim\",\"screenshot_region\":\"auto\",\"screenshot_delay\":10,\"default_desktop\":false,\"default_mobile\":false,\"triggers\":[{\"type\":\"post_save\",\"scope\":\"url\"}],\"css\":\".btn {visibility: none;}\",\"js\":\"\",\"threshold\":0.4}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"023c282c-6513-420a-a36b-a654312ab229\",\"name\":\"Example Group\",\"monitoring\":true,\"enabled\":true,\"hour_of_day\":0,\"interval_in_h\":24,\"schedule_type\":\"interval\",\"schedule_days\":null,\"quiet_hours_start\":null,\"quiet_hours_end\":null,\"triggers\":[],\"alert_emails\":\"hello@example.com,test@foobar.com\",\"css\":\".btn {visibility: none;}\",\"js\":\"\",\"cms\":\"wordpress\",\"threshold\":0.2,\"urls_count\":42,\"selected_urls_count\":37,\"basic_auth_user\":null,\"has_basic_auth\":false,\"proxy_type\":\"none\",\"proxy_country\":\"us\"}}", "name": "" } ] }, { "name": "Get Group", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/groups\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v2\/groups\/:id", "variable": [ { "id": "id", "key": "id", "value": "023c282c-6513-420a-a36b-a654312ab229", "description": "The ID of the Group." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieves a Group object identfied by their ID" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"023c282c-6513-420a-a36b-a654312ab229\",\"name\":\"Example Group\",\"monitoring\":true,\"enabled\":true,\"hour_of_day\":0,\"interval_in_h\":24,\"alert_emails\":\"hello@example.com,test@foobar.com\",\"css\":null,\"js\":null,\"cms\":\"wordpress\",\"threshold\":0.2,\"urls_count\":42,\"selected_urls_count\":37,\"basic_auth_user\":null,\"has_basic_auth\":false,\"proxy_type\":\"none\",\"proxy_country\":\"us\"}}", "name": "" } ] }, { "name": "Update Group", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/groups\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v2\/groups\/:id", "variable": [ { "id": "id", "key": "id", "value": "023c282c-6513-420a-a36b-a654312ab229", "description": "The ID of the Group." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Example Group\",\"monitoring\":true,\"enabled\":true,\"hour_of_day\":0,\"interval_in_h\":24,\"schedule_type\":\"interval\",\"schedule_days\":[1,3,5],\"quiet_hours_start\":22,\"quiet_hours_end\":6,\"alert_emails\":[\"hello@example.com\",\"mail@example.com\"],\"css\":\".btn {visibility: none;}\",\"js\":\"\",\"threshold\":0.4,\"basic_auth_user\":\"admin\",\"basic_auth_password\":\"secret123\",\"proxy_type\":\"none\",\"proxy_country\":\"facilis\",\"screenshot_region\":\"auto\",\"screenshot_delay\":10,\"default_desktop\":false,\"default_mobile\":false,\"triggers\":[{\"type\":\"post_save\",\"scope\":\"url\"}]}" }, "description": "Updates the specified `Group` by setting the values of the parameters passed.\nAny parameters not provided will be left unchanged." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"023c282c-6513-420a-a36b-a654312ab229\",\"name\":\"Example Group\",\"monitoring\":true,\"enabled\":true,\"hour_of_day\":0,\"interval_in_h\":24,\"schedule_type\":\"interval\",\"schedule_days\":null,\"quiet_hours_start\":null,\"quiet_hours_end\":null,\"triggers\":[],\"alert_emails\":\"hello@example.com,test@foobar.com\",\"css\":\".btn {visibility: none;}\",\"js\":\"\",\"cms\":\"wordpress\",\"threshold\":0.2,\"urls_count\":42,\"selected_urls_count\":37,\"basic_auth_user\":\"admin\",\"has_basic_auth\":true,\"proxy_type\":\"static\",\"proxy_country\":\"us\"}}", "name": "" } ] }, { "name": "Delete Group", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/groups\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v2\/groups\/:id", "variable": [ { "id": "id", "key": "id", "value": "023c282c-6513-420a-a36b-a654312ab229", "description": "The ID of the Group." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Permanently deletes a `Group`. This cannot be undone.\n