cURL
curl -X PUT "https://api.sitespy.app/api/v1/watch/095be615-a8ad-4c33-8e9c-c7612fbf6c9f" \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"url": "https://updated-example.com",
"title": "Updated Monitor",
"paused": false
}'import requests
headers = {
'x-api-key': 'YOUR_API_KEY',
'Content-Type': 'application/json'
}
uuid = '095be615-a8ad-4c33-8e9c-c7612fbf6c9f'
data = {
'url': 'https://updated-example.com',
'title': 'Updated Monitor',
'paused': False
}
response = requests.put(f'https://api.sitespy.app/api/v1/watch/{uuid}',
headers=headers, json=data)
print(response.text)
const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
url: '<string>',
title: '<string>',
tag: '<string>',
tags: ['<string>'],
paused: true,
notification_muted: true,
notification_rate_limit_per_hour: 1,
notification_rate_limit_per_day: 1,
fetch_backend: 'system',
headers: {},
body: JSON.stringify('<string>'),
proxy: '<string>',
ignore_status_codes: true,
webdriver_delay: 30,
disable_javascript: false,
mobile_view: false,
noise_reduction_ads: true,
webdriver_js_execute_code: '<string>',
time_between_check: {
weeks: 26000,
days: 182500,
hours: 4380000,
minutes: 262800000,
seconds: 15768000000
},
time_between_check_use_default: true,
notification_urls: ['<string>'],
notification_title: '<string>',
notification_body: '<string>',
track_ldjson_price_data: true,
browser_steps: [{operation: '<string>', selector: '<string>', optional_value: '<string>'}],
processor: 'text_json_diff',
screenshot_enabled: false,
include_filters: ['<string>'],
subtractive_selectors: ['<string>'],
ignore_text: ['<string>'],
auto_noise_reduction_enabled: true,
trigger_text: ['<string>'],
text_should_not_be_present: ['<string>'],
alert_on_state_change: true,
extract_text: ['<string>'],
trim_text_whitespace: false,
sort_text_alphabetically: false,
remove_duplicate_lines: false,
check_unique_lines: false,
strip_ignored_lines: true,
filter_text_added: true,
filter_text_removed: true,
filter_text_replaced: true,
in_stock_only: true,
follow_price_changes: true,
price_change_threshold_percent: 123,
notification_screenshot: false,
filter_failure_notification_send: true,
use_page_title_in_list: true,
history_snapshot_max_length: 500,
time_schedule_limit: {
enabled: false,
monday: {enabled: true, start_time: '00:00', duration: {hours: '24', minutes: '00'}},
tuesday: {enabled: true, start_time: '00:00', duration: {hours: '24', minutes: '00'}},
wednesday: {enabled: true, start_time: '00:00', duration: {hours: '24', minutes: '00'}},
thursday: {enabled: true, start_time: '00:00', duration: {hours: '24', minutes: '00'}},
friday: {enabled: true, start_time: '00:00', duration: {hours: '24', minutes: '00'}},
saturday: {enabled: true, start_time: '00:00', duration: {hours: '24', minutes: '00'}},
sunday: {enabled: true, start_time: '00:00', duration: {hours: '24', minutes: '00'}}
},
conditions: [{field: '<string>', operator: '<string>', value: '<string>'}],
conditions_match_logic: 'ALL',
ai_alert_condition: '<string>',
track_what: '<string>',
ai_tuning_started_at: 0,
filters_source: 'manual',
last_viewed: 1
})
};
fetch('https://api.sitespy.app/api/v1/watch/{uuid}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));"OK"{
"message": "<string>",
"erased_at_stage": "include",
"erasing_field": "subtractive_selectors",
"erasing_rules": [
"<string>"
]
}Watch Management
Update watch
Update an existing web page change monitor (watch) using JSON. Accepts the same structure as returned in get single watch information.
PUT
/
watch
/
{uuid}
cURL
curl -X PUT "https://api.sitespy.app/api/v1/watch/095be615-a8ad-4c33-8e9c-c7612fbf6c9f" \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"url": "https://updated-example.com",
"title": "Updated Monitor",
"paused": false
}'import requests
headers = {
'x-api-key': 'YOUR_API_KEY',
'Content-Type': 'application/json'
}
uuid = '095be615-a8ad-4c33-8e9c-c7612fbf6c9f'
data = {
'url': 'https://updated-example.com',
'title': 'Updated Monitor',
'paused': False
}
response = requests.put(f'https://api.sitespy.app/api/v1/watch/{uuid}',
headers=headers, json=data)
print(response.text)
const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
url: '<string>',
title: '<string>',
tag: '<string>',
tags: ['<string>'],
paused: true,
notification_muted: true,
notification_rate_limit_per_hour: 1,
notification_rate_limit_per_day: 1,
fetch_backend: 'system',
headers: {},
body: JSON.stringify('<string>'),
proxy: '<string>',
ignore_status_codes: true,
webdriver_delay: 30,
disable_javascript: false,
mobile_view: false,
noise_reduction_ads: true,
webdriver_js_execute_code: '<string>',
time_between_check: {
weeks: 26000,
days: 182500,
hours: 4380000,
minutes: 262800000,
seconds: 15768000000
},
time_between_check_use_default: true,
notification_urls: ['<string>'],
notification_title: '<string>',
notification_body: '<string>',
track_ldjson_price_data: true,
browser_steps: [{operation: '<string>', selector: '<string>', optional_value: '<string>'}],
processor: 'text_json_diff',
screenshot_enabled: false,
include_filters: ['<string>'],
subtractive_selectors: ['<string>'],
ignore_text: ['<string>'],
auto_noise_reduction_enabled: true,
trigger_text: ['<string>'],
text_should_not_be_present: ['<string>'],
alert_on_state_change: true,
extract_text: ['<string>'],
trim_text_whitespace: false,
sort_text_alphabetically: false,
remove_duplicate_lines: false,
check_unique_lines: false,
strip_ignored_lines: true,
filter_text_added: true,
filter_text_removed: true,
filter_text_replaced: true,
in_stock_only: true,
follow_price_changes: true,
price_change_threshold_percent: 123,
notification_screenshot: false,
filter_failure_notification_send: true,
use_page_title_in_list: true,
history_snapshot_max_length: 500,
time_schedule_limit: {
enabled: false,
monday: {enabled: true, start_time: '00:00', duration: {hours: '24', minutes: '00'}},
tuesday: {enabled: true, start_time: '00:00', duration: {hours: '24', minutes: '00'}},
wednesday: {enabled: true, start_time: '00:00', duration: {hours: '24', minutes: '00'}},
thursday: {enabled: true, start_time: '00:00', duration: {hours: '24', minutes: '00'}},
friday: {enabled: true, start_time: '00:00', duration: {hours: '24', minutes: '00'}},
saturday: {enabled: true, start_time: '00:00', duration: {hours: '24', minutes: '00'}},
sunday: {enabled: true, start_time: '00:00', duration: {hours: '24', minutes: '00'}}
},
conditions: [{field: '<string>', operator: '<string>', value: '<string>'}],
conditions_match_logic: 'ALL',
ai_alert_condition: '<string>',
track_what: '<string>',
ai_tuning_started_at: 0,
filters_source: 'manual',
last_viewed: 1
})
};
fetch('https://api.sitespy.app/api/v1/watch/{uuid}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));"OK"{
"message": "<string>",
"erased_at_stage": "include",
"erasing_field": "subtractive_selectors",
"erasing_rules": [
"<string>"
]
}Authorizations
API key for authentication. You can find your API key in the Site Spy dashboard under Settings → API.
Path Parameters
Web page change monitor (watch) unique ID
Body
application/json
URL to monitor for changes
Maximum string length:
5000Custom title for the web page change monitor (watch), not to be confused with page_title
Maximum string length:
5000Tag UUID to associate with this web page change monitor (watch)
Maximum string length:
5000Array of tag UUIDs
Whether the web page change monitor (watch) is paused
Whether notifications are muted
Per-watch cap on notifications sent per hour. null uses the system default, 0 means unlimited.
Required range:
x >= 0Per-watch cap on notifications sent per day. null uses the system default, 0 means unlimited.
Required range:
x >= 0HTTP method to use
Available options:
GET, POST, DELETE, PUT Backend to use for fetching content. Common values:
system(default) - Use the system-wide default fetcherhtml_requests- Fast requests-based fetcherhtml_webdriver- Browser-based fetcher (Playwright/Puppeteer)extra_browser_*- Custom browser configurations (if configured)- Plugin-provided fetchers (if installed)
Pattern:
^(system|html_requests|html_hybrid|html_webdriver|extra_browser_.+)$HTTP headers to include in requests
Show child attributes
Show child attributes
HTTP request body
Maximum string length:
5000Proxy configuration
Maximum string length:
5000Ignore HTTP status code errors (boolean or null)
Seconds to wait after page load before extracting content (browser backends only). null uses the system default.
Required range:
0 <= x <= 60Render the page in the browser with JavaScript execution disabled. Forces a browser backend.
Render the page with a mobile viewport, device pixel ratio, touch support and a mobile User-Agent. Forces a browser backend.
Block ads and cookie banners for this watch; null inherits the account-level setting of the same name
JavaScript code to execute
Maximum string length:
5000Time intervals between checks. All fields must be non-negative. At least one non-zero value required when not using default settings.
Show child attributes
Show child attributes
Whether to use global settings for time between checks - defaults to true if not set
Notification URLs for this web page change monitor (watch). Maximum 100 URLs.
Maximum array length:
100Maximum string length:
1000Custom notification title
Maximum string length:
5000Custom notification body
Maximum string length:
5000Format for notifications
Available options:
text, html, htmlcolor, markdown, System default Whether to track JSON-LD price data
Browser automation steps. Maximum 100 steps allowed.
Maximum array length:
100Show child attributes
Show child attributes
Optional processor mode to use for change detection. image_ssim_diff (screenshot monitoring) requires Pro plan. Defaults to text_json_diff if not specified.
Available options:
restock_diff, text_json_diff, image_ssim_diff When true, capture and store screenshots alongside text snapshots on each check. Requires Pro plan and fetch_backend set to a browser-based fetcher (e.g. html_webdriver).
CSS/XPath selectors naming the part of the page this watch follows, and the only part that can trigger a notification. In the dashboard, the AI chat and the browser extension this is set by pointing at the page in the element picker rather than typed; the API accepts it directly. A watch with an empty list follows the whole page, which means every timestamp, banner and counter on it counts as a change. Selectors that the backend cannot compile are dropped on save rather than rejected.
Maximum array length:
100Maximum string length:
5000CSS/XPath selectors to remove content from the page
Maximum array length:
100Maximum string length:
5000Text patterns to ignore in change detection
Maximum array length:
100Maximum string length:
5000Enable automatic noise reduction for this watch; null inherits the account smart-filter setting
Text/regex patterns that must be present to trigger a change
Maximum array length:
100Maximum string length:
5000Text that should NOT be present (triggers alert if found)
Maximum array length:
100Maximum string length:
5000Notify on the check where text_should_not_be_present stops matching, and stay silent otherwise, instead of notifying on every page diff while it does not match. Null derives it: a watch with text_should_not_be_present is waiting for that message to clear unless its stated intent is a generic "any change".
Regex patterns to extract specific text after filtering
Maximum array length:
100Maximum string length:
5000Strip leading/trailing whitespace from text
Sort lines alphabetically before comparison
Remove duplicate lines from content
Compare against all history for unique lines
Remove lines matching ignore patterns
Include added text in change detection
Include removed text in change detection
Include replaced text in change detection
Only trigger on in-stock transitions (restock_diff processor)
Monitor and track price changes (restock_diff processor)
Minimum price change percentage to trigger notification
Include screenshot in notifications (if supported by notification URL)
Send notification when filters fail to match content
Display page title in watch list (null = use system default)
Maximum number of history snapshots to keep (null = use system default)
Required range:
1 <= x <= 1000Weekly schedule limiting when checks can run
Show child attributes
Show child attributes
Array of condition rules for change detection logic (empty array when not set)
Maximum array length:
100Show child attributes
Show child attributes
Logic operator - ALL (match all conditions) or ANY (match any condition)
Available options:
ALL, ANY Plain-English condition for AI smart alerts (Pro+ only). When set, AI evaluates each change against this condition and suppresses notifications that don't match. Example - "Only notify me if the price drops below $50".
Maximum string length:
500User's monitoring intent, e.g. "price changes", "new job listings". Set by the add-watch form or AI chat when the user describes what they want to track.
Maximum string length:
500Unix timestamp set while an automatic filter repair is running for this watch, and zero when it is not. Lets the dashboard show the work as watch state that survives a page refresh.
Who chose this watch's include filter - 'manual' for a person, 'smart' for the removed smart-configure generator. It decides what happens when the include filter stops matching: a person's selector raises an error, a machine's silently falls back to the whole page. Nothing writes 'smart' any more, and watches configured before it was removed still carry the value with their filters honoured unchanged - but an edit that changes include_filters now records 'manual', since whoever made that edit chose the selector. Send the field explicitly to override that.
Available options:
manual, smart Unix timestamp in seconds of the last time the watch was viewed. Setting it to a value higher than last_changed in the "Update watch" endpoint marks the watch as viewed.
Required range:
x >= 0Response
Web page change monitor (watch) updated successfully
The response is of type string.
Example:
"OK"