mirror of
https://github.com/dgtlmoon/changedetection.io.git
synced 2026-11-07 06:23:05 +00:00
API - Bumping docs
This commit is contained in:
1 parent
c66a29b011
commit
80f7decf4f
2 files changed
+114
-36
No files matched your search
+55
-9
@@ -28,7 +28,7 @@ info:
|
||||
|
||||
For example: `x-api-key: YOUR_API_KEY`
|
||||
|
||||
version: 0.1.4
|
||||
version: 0.1.5
|
||||
contact:
|
||||
name: ChangeDetection.io
|
||||
url: https://github.com/dgtlmoon/changedetection.io
|
||||
@@ -1503,46 +1503,92 @@ paths:
|
||||
post:
|
||||
operationId: importWatches
|
||||
tags: [Import]
|
||||
summary: Import watch URLs
|
||||
description: Import a list of URLs to monitor. Accepts line-separated URLs in request body.
|
||||
summary: Import watch URLs with configuration
|
||||
description: |
|
||||
Import a list of URLs to monitor with optional watch configuration. Accepts line-separated URLs in request body.
|
||||
|
||||
**Configuration via Query Parameters:**
|
||||
|
||||
You can pass ANY watch configuration field as query parameters to apply settings to all imported watches.
|
||||
All parameters from the Watch schema are supported (processor, fetch_backend, notification_urls, etc.).
|
||||
|
||||
**Special Parameters:**
|
||||
- `tag` / `tag_uuids` - Assign tags to imported watches
|
||||
- `proxy` - Use specific proxy for imported watches
|
||||
- `dedupe` - Skip duplicate URLs (default: true)
|
||||
|
||||
**Type Conversion:**
|
||||
- Booleans: `true`, `false`, `1`, `0`, `yes`, `no`
|
||||
- Arrays: Comma-separated or JSON format (`[item1,item2]`)
|
||||
- Objects: JSON format (`{"key":"value"}`)
|
||||
- Numbers: Parsed as int or float
|
||||
x-code-samples:
|
||||
- lang: 'curl'
|
||||
source: |
|
||||
# Basic import
|
||||
curl -X POST "http://localhost:5000/api/v1/import" \
|
||||
-H "x-api-key: YOUR_API_KEY" \
|
||||
-H "Content-Type: text/plain" \
|
||||
-d $'https://example.com\nhttps://example.org\nhttps://example.net'
|
||||
|
||||
# Import with processor and fetch backend
|
||||
curl -X POST "http://localhost:5000/api/v1/import?processor=restock_diff&fetch_backend=html_webdriver" \
|
||||
-H "x-api-key: YOUR_API_KEY" \
|
||||
-H "Content-Type: text/plain" \
|
||||
-d $'https://example.com\nhttps://example.org'
|
||||
|
||||
# Import with multiple settings
|
||||
curl -X POST "http://localhost:5000/api/v1/import?processor=restock_diff&paused=true&tag=production" \
|
||||
-H "x-api-key: YOUR_API_KEY" \
|
||||
-H "Content-Type: text/plain" \
|
||||
-d $'https://example.com'
|
||||
- lang: 'Python'
|
||||
source: |
|
||||
import requests
|
||||
|
||||
|
||||
headers = {
|
||||
'x-api-key': 'YOUR_API_KEY',
|
||||
'Content-Type': 'text/plain'
|
||||
}
|
||||
|
||||
# Basic import
|
||||
urls = 'https://example.com\nhttps://example.org\nhttps://example.net'
|
||||
response = requests.post('http://localhost:5000/api/v1/import',
|
||||
response = requests.post('http://localhost:5000/api/v1/import',
|
||||
headers=headers, data=urls)
|
||||
print(response.json())
|
||||
|
||||
# Import with configuration
|
||||
params = {
|
||||
'processor': 'restock_diff',
|
||||
'fetch_backend': 'html_webdriver',
|
||||
'paused': 'false',
|
||||
'tag': 'production'
|
||||
}
|
||||
response = requests.post('http://localhost:5000/api/v1/import',
|
||||
headers=headers, params=params, data=urls)
|
||||
print(response.json())
|
||||
parameters:
|
||||
- name: tag_uuids
|
||||
in: query
|
||||
description: Tag UUID to apply to imported web page change monitors (watches)
|
||||
description: Tag UUID(s) to apply to imported watches (comma-separated for multiple)
|
||||
schema:
|
||||
type: string
|
||||
example: "550e8400-e29b-41d4-a716-446655440000"
|
||||
- name: tag
|
||||
in: query
|
||||
description: Tag name to apply to imported web page change monitors (watches)
|
||||
description: Tag name to apply to imported watches
|
||||
schema:
|
||||
type: string
|
||||
example: "production"
|
||||
- name: proxy
|
||||
in: query
|
||||
description: Proxy key to use for imported web page change monitors (watches)
|
||||
description: Proxy key to use for imported watches
|
||||
schema:
|
||||
type: string
|
||||
example: "proxy1"
|
||||
- name: dedupe
|
||||
in: query
|
||||
description: Remove duplicate URLs (default true)
|
||||
description: Skip duplicate URLs (default true)
|
||||
schema:
|
||||
type: boolean
|
||||
default: true
|
||||
|
||||
+59
-27
@@ -432,7 +432,7 @@ data-styled.g138[id="sc-enPhjR"]{content:"SikXG,"}/*!sc*/
|
||||
|
||||
<body>
|
||||
|
||||
<div id="redoc"><div class="sc-Pgsbw eHdqcJ redoc-wrap"><div class="sc-fstJre dsiHUZ menu-content" style="top:0px;height:calc(100vh - 0px)"><div role="search" class="sc-iRcyzz gzMPIt"><svg class="sc-enPhjR SikXG search-icon" version="1.1" viewBox="0 0 1000 1000" x="0px" xmlns="http://www.w3.org/2000/svg" y="0px"><path d="M968.2,849.4L667.3,549c83.9-136.5,66.7-317.4-51.7-435.6C477.1-25,252.5-25,113.9,113.4c-138.5,138.3-138.5,362.6,0,501C219.2,730.1,413.2,743,547.6,666.5l301.9,301.4c43.6,43.6,76.9,14.9,104.2-12.4C981,928.3,1011.8,893,968.2,849.4z M524.5,522c-88.9,88.7-233,88.7-321.8,0c-88.9-88.7-88.9-232.6,0-321.3c88.9-88.7,233-88.7,321.8,0C613.4,289.4,613.4,433.3,524.5,522z"></path></svg><input placeholder="Search..." aria-label="Search" type="text" class="sc-lhsSio iOkeQy search-input" value=""/></div><div class="sc-eknHtZ ghzOpX scrollbar-container undefined"><ul role="menu" class="sc-zOxLx gAPKXX"><li tabindex="0" depth="1" data-item-id="section/ChangeDetection.io-Web-page-monitoring-and-notifications-API" role="menuitem" aria-label="ChangeDetection.io Web page monitoring and notifications API" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz lgPGwq -depth1"><span width="calc(100% - 38px)" title="ChangeDetection.io Web page monitoring and notifications API" class="sc-gWaSiO cxcra">ChangeDetection.io Web page monitoring and notifications API</span><svg class="sc-dntSTA dUlzCe" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-zOxLx dQnkdy"><li tabindex="0" depth="2" data-item-id="section/ChangeDetection.io-Web-page-monitoring-and-notifications-API/Where-to-find-my-API-key" role="menuitem" aria-label="Where to find my API key?" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz fTDmgC -depth2"><span width="calc(100% - 38px)" title="Where to find my API key?" class="sc-gWaSiO cxcra">Where to find my API key?</span></label></li><li tabindex="0" depth="2" data-item-id="section/ChangeDetection.io-Web-page-monitoring-and-notifications-API/Connection-URL" role="menuitem" aria-label="Connection URL" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz fTDmgC -depth2"><span width="calc(100% - 38px)" title="Connection URL" class="sc-gWaSiO cxcra">Connection URL</span></label></li><li tabindex="0" depth="2" data-item-id="section/ChangeDetection.io-Web-page-monitoring-and-notifications-API/Authentication" role="menuitem" aria-label="Authentication" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz fTDmgC -depth2"><span width="calc(100% - 38px)" title="Authentication" class="sc-gWaSiO cxcra">Authentication</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Watch-Management" role="menuitem" aria-label="Watch Management" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz lgPGwq -depth1"><span width="calc(100% - 38px)" title="Watch Management" class="sc-gWaSiO cxcra">Watch Management</span><svg class="sc-dntSTA dUlzCe" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-zOxLx dQnkdy"><li tabindex="0" depth="2" data-item-id="tag/Watch-Management/operation/listWatches" role="menuitem" aria-label="List all watches" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="get" class="sc-jxYSNo NmQLu operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">List all watches</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Watch-Management/operation/createWatch" role="menuitem" aria-label="Create a new watch" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="post" class="sc-jxYSNo NmQLu operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">Create a new watch</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Watch-Management/operation/getWatch" role="menuitem" aria-label="Get single watch" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="get" class="sc-jxYSNo NmQLu operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">Get single watch</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Watch-Management/operation/updateWatch" role="menuitem" aria-label="Update watch" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="put" class="sc-jxYSNo NmQLu operation-type put">put</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">Update watch</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Watch-Management/operaLine truncated
|
||||
<div id="redoc"><div class="sc-Pgsbw eHdqcJ redoc-wrap"><div class="sc-fstJre dsiHUZ menu-content" style="top:0px;height:calc(100vh - 0px)"><div role="search" class="sc-iRcyzz gzMPIt"><svg class="sc-enPhjR SikXG search-icon" version="1.1" viewBox="0 0 1000 1000" x="0px" xmlns="http://www.w3.org/2000/svg" y="0px"><path d="M968.2,849.4L667.3,549c83.9-136.5,66.7-317.4-51.7-435.6C477.1-25,252.5-25,113.9,113.4c-138.5,138.3-138.5,362.6,0,501C219.2,730.1,413.2,743,547.6,666.5l301.9,301.4c43.6,43.6,76.9,14.9,104.2-12.4C981,928.3,1011.8,893,968.2,849.4z M524.5,522c-88.9,88.7-233,88.7-321.8,0c-88.9-88.7-88.9-232.6,0-321.3c88.9-88.7,233-88.7,321.8,0C613.4,289.4,613.4,433.3,524.5,522z"></path></svg><input placeholder="Search..." aria-label="Search" type="text" class="sc-lhsSio iOkeQy search-input" value=""/></div><div class="sc-eknHtZ ghzOpX scrollbar-container undefined"><ul role="menu" class="sc-zOxLx gAPKXX"><li tabindex="0" depth="1" data-item-id="section/ChangeDetection.io-Web-page-monitoring-and-notifications-API" role="menuitem" aria-label="ChangeDetection.io Web page monitoring and notifications API" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz lgPGwq -depth1"><span width="calc(100% - 38px)" title="ChangeDetection.io Web page monitoring and notifications API" class="sc-gWaSiO cxcra">ChangeDetection.io Web page monitoring and notifications API</span><svg class="sc-dntSTA dUlzCe" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-zOxLx dQnkdy"><li tabindex="0" depth="2" data-item-id="section/ChangeDetection.io-Web-page-monitoring-and-notifications-API/Where-to-find-my-API-key" role="menuitem" aria-label="Where to find my API key?" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz fTDmgC -depth2"><span width="calc(100% - 38px)" title="Where to find my API key?" class="sc-gWaSiO cxcra">Where to find my API key?</span></label></li><li tabindex="0" depth="2" data-item-id="section/ChangeDetection.io-Web-page-monitoring-and-notifications-API/Connection-URL" role="menuitem" aria-label="Connection URL" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz fTDmgC -depth2"><span width="calc(100% - 38px)" title="Connection URL" class="sc-gWaSiO cxcra">Connection URL</span></label></li><li tabindex="0" depth="2" data-item-id="section/ChangeDetection.io-Web-page-monitoring-and-notifications-API/Authentication" role="menuitem" aria-label="Authentication" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz fTDmgC -depth2"><span width="calc(100% - 38px)" title="Authentication" class="sc-gWaSiO cxcra">Authentication</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Watch-Management" role="menuitem" aria-label="Watch Management" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz lgPGwq -depth1"><span width="calc(100% - 38px)" title="Watch Management" class="sc-gWaSiO cxcra">Watch Management</span><svg class="sc-dntSTA dUlzCe" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-zOxLx dQnkdy"><li tabindex="0" depth="2" data-item-id="tag/Watch-Management/operation/listWatches" role="menuitem" aria-label="List all watches" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="get" class="sc-jxYSNo NmQLu operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">List all watches</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Watch-Management/operation/createWatch" role="menuitem" aria-label="Create a new watch" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="post" class="sc-jxYSNo NmQLu operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">Create a new watch</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Watch-Management/operation/getWatch" role="menuitem" aria-label="Get single watch" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="get" class="sc-jxYSNo NmQLu operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">Get single watch</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Watch-Management/operation/updateWatch" role="menuitem" aria-label="Update watch" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="put" class="sc-jxYSNo NmQLu operation-type put">put</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">Update watch</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Watch-Management/operaLine truncated
|
||||
m -673.67664,1221.6502 -231.2455,-231.24803 55.6165,
|
||||
-55.627 c 30.5891,-30.59485 56.1806,-55.627 56.8701,-55.627 0.6894,
|
||||
0 79.8637,78.60862 175.9427,174.68583 l 174.6892,174.6858 174.6892,
|
||||
@@ -450,7 +450,7 @@ data-styled.g138[id="sc-enPhjR"]{content:"SikXG,"}/*!sc*/
|
||||
55.627 l 55.6165,55.627 -231.245496,231.24803 c -127.185,127.1864
|
||||
-231.5279,231.248 -231.873,231.248 -0.3451,0 -104.688,
|
||||
-104.0616 -231.873,-231.248 z
|
||||
" fill="currentColor"></path></g></svg></div></div><div class="sc-fkYqBV buanwU api-content"><div class="sc-dTvVRJ bPmFpz"><div class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU api-info"><h1 class="sc-hwkwBN sc-jCWzJg wYHiz hPcPCj">ChangeDetection.io API<!-- --> <span>(<!-- -->0.1.4<!-- -->)</span></h1><p>Download OpenAPI specification<!-- -->:</p><div class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><div class="sc-erPUmh eAqtbt"><div class="sc-iRTMaw beOrEi"> <span class="sc-jVxTAy hijBKj">URL: <a href="https://github.com/dgtlmoon/changedetection.io">https://github.com/dgtlmoon/changedetection.io</a></span> <span class="sc-jVxTAy hijBKj">License:<!-- --> <a href="https://www.apache.org/licenses/LICENSE-2.0.html">Apache 2.0</a></span> </div></div></div><div data-role="redoc-summary" html="" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"></div><div data-role="redoc-description" html="" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"></div></div></div></div><div id="section/ChangeDetection.io-Web-page-monitoring-and-notifications-API" data-section-id="section/ChangeDetection.io-Web-page-monitoring-and-notifications-API" class="sc-dTvVRJ bPmFpz"><div class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#section/ChangeDetection.io-Web-page-monitoring-and-notifications-API" aria-label="section/ChangeDetection.io-Web-page-monitoring-and-notifications-API"></a>ChangeDetection.io Web page monitoring and notifications API</h2></div></div><div class="sc-ggWZvA dCzIPc"><div class="sc-eVqvcJ sc-fszimp kIppRw kbZred redoc-markdown " html="<p>REST API for managing Page watches, Group tags, and Notifications.</p>
|
||||
" fill="currentColor"></path></g></svg></div></div><div class="sc-fkYqBV buanwU api-content"><div class="sc-dTvVRJ bPmFpz"><div class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU api-info"><h1 class="sc-hwkwBN sc-jCWzJg wYHiz hPcPCj">ChangeDetection.io API<!-- --> <span>(<!-- -->0.1.5<!-- -->)</span></h1><p>Download OpenAPI specification<!-- -->:</p><div class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><div class="sc-erPUmh eAqtbt"><div class="sc-iRTMaw beOrEi"> <span class="sc-jVxTAy hijBKj">URL: <a href="https://github.com/dgtlmoon/changedetection.io">https://github.com/dgtlmoon/changedetection.io</a></span> <span class="sc-jVxTAy hijBKj">License:<!-- --> <a href="https://www.apache.org/licenses/LICENSE-2.0.html">Apache 2.0</a></span> </div></div></div><div data-role="redoc-summary" html="" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"></div><div data-role="redoc-description" html="" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"></div></div></div></div><div id="section/ChangeDetection.io-Web-page-monitoring-and-notifications-API" data-section-id="section/ChangeDetection.io-Web-page-monitoring-and-notifications-API" class="sc-dTvVRJ bPmFpz"><div class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#section/ChangeDetection.io-Web-page-monitoring-and-notifications-API" aria-label="section/ChangeDetection.io-Web-page-monitoring-and-notifications-API"></a>ChangeDetection.io Web page monitoring and notifications API</h2></div></div><div class="sc-ggWZvA dCzIPc"><div class="sc-eVqvcJ sc-fszimp kIppRw kbZred redoc-markdown " html="<p>REST API for managing Page watches, Group tags, and Notifications.</p>
|
||||
<p>changedetection.io can be driven by its built in simple API, in the examples below you will also find <code>curl</code> command line and <code>python</code> examples to help you get started faster.</p>
|
||||
"><p>REST API for managing Page watches, Group tags, and Notifications.</p>
|
||||
<p>changedetection.io can be driven by its built in simple API, in the examples below you will also find <code>curl</code> command line and <code>python</code> examples to help you get started faster.</p>
|
||||
@@ -532,12 +532,12 @@ notification preferences, and content filtering options.</p>
|
||||
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Delay in seconds for webdriver</p>
|
||||
</div></div></div></td></tr><tr class=""><td kind="field" title="webdriver_js_execute_code" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">webdriver_js_execute_code</span></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span><span> <span class="sc-bEjUoa sc-goiVcJ lhyyLL bDfgbe"> <!-- --><= 5000 characters<!-- --> </span></span></div> <div><div html="<p>JavaScript code to execute</p>
|
||||
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>JavaScript code to execute</p>
|
||||
</div></div></div></td></tr><tr class=""><td kind="field" title="time_between_check" class="sc-kCuUfV sc-fbQrwq sc-itBLYH gdmNWp dFOJWJ kdPQHX"><span class="sc-hwddKA cteAyA"></span><button aria-label="expand time_between_check"><span class="property-name">time_between_check</span><svg class="sc-dntSTA dOPmTa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">object</span></div> <div><div html="<p>Time intervals between checks</p>
|
||||
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Time intervals between checks</p>
|
||||
</div></div></div></td></tr><tr class=""><td kind="field" title="time_between_check" class="sc-kCuUfV sc-fbQrwq sc-itBLYH gdmNWp dFOJWJ kdPQHX"><span class="sc-hwddKA cteAyA"></span><button aria-label="expand time_between_check"><span class="property-name">time_between_check</span><svg class="sc-dntSTA dOPmTa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">object</span></div> <div><div html="<p>Time intervals between checks. All fields must be non-negative. At least one non-zero value required when not using default settings.</p>
|
||||
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Time intervals between checks. All fields must be non-negative. At least one non-zero value required when not using default settings.</p>
|
||||
</div></div></div></td></tr><tr class=""><td kind="field" title="time_between_check_use_default" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">time_between_check_use_default</span></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">boolean</span></div><div><span class="sc-bEjUoa lhyyLL"> <!-- -->Default:<!-- --> </span> <span class="sc-bEjUoa sc-dTWiOz lhyyLL kMQdIk">true</span></div> <div><div html="<p>Whether to use global settings for time between checks - defaults to true if not set</p>
|
||||
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Whether to use global settings for time between checks - defaults to true if not set</p>
|
||||
</div></div></div></td></tr><tr class=""><td kind="field" title="notification_urls" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">notification_urls</span></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP">Array of </span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">strings</span></div> <div><div html="<p>Notification URLs for this web page change monitor (watch)</p>
|
||||
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Notification URLs for this web page change monitor (watch)</p>
|
||||
</div></div></div></td></tr><tr class=""><td kind="field" title="notification_urls" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">notification_urls</span></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP">Array of </span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">strings</span><span> <span class="sc-bEjUoa sc-goiVcJ lhyyLL bDfgbe"> <!-- --><= 100 items<!-- --> </span></span><span class="sc-bEjUoa sc-boKDdR sc-bBhMX lhyyLL jYezsP eA-DYPM">[ items<span> <span class="sc-bEjUoa sc-goiVcJ lhyyLL bDfgbe"> <!-- --><= 1000 characters<!-- --> </span></span> ]</span></div> <div><div html="<p>Notification URLs for this web page change monitor (watch). Maximum 100 URLs.</p>
|
||||
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Notification URLs for this web page change monitor (watch). Maximum 100 URLs.</p>
|
||||
</div></div></div></td></tr><tr class=""><td kind="field" title="notification_title" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">notification_title</span></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span><span> <span class="sc-bEjUoa sc-goiVcJ lhyyLL bDfgbe"> <!-- --><= 5000 characters<!-- --> </span></span></div> <div><div html="<p>Custom notification title</p>
|
||||
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Custom notification title</p>
|
||||
</div></div></div></td></tr><tr class=""><td kind="field" title="notification_body" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">notification_body</span></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span><span> <span class="sc-bEjUoa sc-goiVcJ lhyyLL bDfgbe"> <!-- --><= 5000 characters<!-- --> </span></span></div> <div><div html="<p>Custom notification body</p>
|
||||
@@ -546,8 +546,8 @@ notification preferences, and content filtering options.</p>
|
||||
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Format for notifications</p>
|
||||
</div></div></div></td></tr><tr class=""><td kind="field" title="track_ldjson_price_data" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">track_ldjson_price_data</span></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">boolean</span></div> <div><div html="<p>Whether to track JSON-LD price data</p>
|
||||
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Whether to track JSON-LD price data</p>
|
||||
</div></div></div></td></tr><tr class=""><td kind="field" title="browser_steps" class="sc-kCuUfV sc-fbQrwq sc-itBLYH gdmNWp dFOJWJ kdPQHX"><span class="sc-hwddKA cteAyA"></span><button aria-label="expand browser_steps"><span class="property-name">browser_steps</span><svg class="sc-dntSTA dOPmTa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP">Array of </span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">objects</span></div> <div><div html="<p>Browser automation steps</p>
|
||||
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Browser automation steps</p>
|
||||
</div></div></div></td></tr><tr class=""><td kind="field" title="browser_steps" class="sc-kCuUfV sc-fbQrwq sc-itBLYH gdmNWp dFOJWJ kdPQHX"><span class="sc-hwddKA cteAyA"></span><button aria-label="expand browser_steps"><span class="property-name">browser_steps</span><svg class="sc-dntSTA dOPmTa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP">Array of </span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">objects</span><span> <span class="sc-bEjUoa sc-goiVcJ lhyyLL bDfgbe"> <!-- --><= 100 items<!-- --> </span></span></div> <div><div html="<p>Browser automation steps. Maximum 100 steps allowed.</p>
|
||||
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Browser automation steps. Maximum 100 steps allowed.</p>
|
||||
</div></div></div></td></tr><tr class="last "><td kind="field" title="processor" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">processor</span></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span></div><div><span class="sc-bEjUoa lhyyLL"> <!-- -->Default:<!-- --> </span> <span class="sc-bEjUoa sc-dTWiOz lhyyLL kMQdIk">"text_json_diff"</span></div><div><span class="sc-bEjUoa lhyyLL"> <!-- -->Enum<!-- -->:</span> <span class="sc-bEjUoa sc-dTWiOz lhyyLL kMQdIk">"restock_diff"</span> <span class="sc-bEjUoa sc-dTWiOz lhyyLL kMQdIk">"text_json_diff"</span> </div> <div><div html="<p>Optional processor mode to use for change detection. Defaults to <code>text_json_diff</code> if not specified.</p>
|
||||
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Optional processor mode to use for change detection. Defaults to <code>text_json_diff</code> if not specified.</p>
|
||||
</div></div></div></td></tr></tbody></table><div><h3 class="sc-gDzyrw kjrVcG">Responses</h3><div><button class="sc-jIDBmd lkmdtA"><svg class="sc-dntSTA cGxVlA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">200<!-- --> </strong><div html="<p>Web page change monitor (watch) created successfully</p>
|
||||
@@ -582,7 +582,7 @@ notification preferences, and content filtering options.</p>
|
||||
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Custom server</p>
|
||||
</div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span>{protocol}://{host}/api/v1</span>/watch/{uuid}</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Request samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab_R_2abha_0" aria-selected="true" aria-disabled="false" aria-controls="panel_R_2abha_0" tabindex="0" data-rttab="true">curl</li><li class="react-tabs__tab" role="tab" id="tab_R_2abha_1" aria-selected="false" aria-disabled="false" aria-controls="panel_R_2abha_1" data-rttab="true">Python</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel_R_2abha_0" aria-labelledby="tab_R_2abha_0"><div class="sc-cdmAjP gsEOpk"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button></div><pre class="sc-eVqvcJ sc-jytpVa kIppRw cCzeOT">curl <span class="token operator">-</span>X GET <span class="token string">"http://localhost:5000/api/v1/watch/095be615-a8ad-4c33-8e9c-c7612fbf6c9f"</span> \
|
||||
<span class="token operator">-</span>H <span class="token string">"x-api-key: YOUR_API_KEY"</span>
|
||||
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel_R_2abha_1" aria-labelledby="tab_R_2abha_1"></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab_R_2ebha_0" aria-selected="true" aria-disabled="false" aria-controls="panel_R_2ebha_0" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="tab_R_2ebha_1" aria-selected="false" aria-disabled="false" aria-controls="panel_R_2ebha_1" data-rttab="true">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel_R_2ebha_0" aria-labelledby="tab_R_2ebha_0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-cCVJLD sc-gsJsQu dbfEBv ehbHlf"><svg class="sc-pYNGo eyTvTk" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/json" selected="">application/json</option><option value="text/plain">text/plain</option></select><label>application/json</label></div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"url"</span>: <span class="token string">"</span><a href="http://example.com">http://example.com</a><span class="token string">"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"title"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"tag"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"tags"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"paused"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"notification_muted"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"method"</span>: <span class="token string">"GET"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"fetch_backend"</span>: <span class="token string">"html_requests"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"headers"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"body"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"proxy"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"webdriver_delay"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"webdriver_js_execute_code"</span>: <span class="token string">"string&Line truncated
|
||||
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel_R_2abha_1" aria-labelledby="tab_R_2abha_1"></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab_R_2ebha_0" aria-selected="true" aria-disabled="false" aria-controls="panel_R_2ebha_0" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="tab_R_2ebha_1" aria-selected="false" aria-disabled="false" aria-controls="panel_R_2ebha_1" data-rttab="true">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel_R_2ebha_0" aria-labelledby="tab_R_2ebha_0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-cCVJLD sc-gsJsQu dbfEBv ehbHlf"><svg class="sc-pYNGo eyTvTk" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/json" selected="">application/json</option><option value="text/plain">text/plain</option></select><label>application/json</label></div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"url"</span>: <span class="token string">"</span><a href="http://example.com">http://example.com</a><span class="token string">"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"title"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"tag"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"tags"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"paused"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"notification_muted"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"method"</span>: <span class="token string">"GET"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"fetch_backend"</span>: <span class="token string">"html_requests"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"headers"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"body"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"proxy"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"webdriver_delay"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"webdriver_js_execute_code"</span>: <span class="token string">"string&Line truncated
|
||||
" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><p>Update an existing web page change monitor (watch) using JSON. Accepts the same structure as returned in <a href="#operation/getWatch">get single watch information</a>.</p>
|
||||
</div></div><div class="sc-ikkVnJ deUlC"><div class="sc-hWgKua dPSGXF"><h5 class="sc-eqYatC sc-gFqXPY czjApA jCoZLr">Authorizations:</h5><svg class="sc-dntSTA FtowP" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jBaHRL fUkQtw"><span class="sc-iVnIWt gRXavu"><span class="sc-hqtLyI hRtRoN"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-eqYatC czjApA">path<!-- --> Parameters</h5><table class="sc-eqNDNG icJLQx"><tbody><tr class="last "><td kind="field" title="uuid" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">uuid</span><div class="sc-bEjUoa sc-iIvHqT lhyyLL crXmiY">required</div></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq"> <!-- --><<!-- -->uuid<!-- -->><!-- --> </span></div> <div><div html="<p>Web page change monitor (watch) unique ID</p>
|
||||
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Web page change monitor (watch) unique ID</p>
|
||||
@@ -612,12 +612,12 @@ notification preferences, and content filtering options.</p>
|
||||
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Delay in seconds for webdriver</p>
|
||||
</div></div></div></td></tr><tr class=""><td kind="field" title="webdriver_js_execute_code" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">webdriver_js_execute_code</span></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span><span> <span class="sc-bEjUoa sc-goiVcJ lhyyLL bDfgbe"> <!-- --><= 5000 characters<!-- --> </span></span></div> <div><div html="<p>JavaScript code to execute</p>
|
||||
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>JavaScript code to execute</p>
|
||||
</div></div></div></td></tr><tr class=""><td kind="field" title="time_between_check" class="sc-kCuUfV sc-fbQrwq sc-itBLYH gdmNWp dFOJWJ kdPQHX"><span class="sc-hwddKA cteAyA"></span><button aria-label="expand time_between_check"><span class="property-name">time_between_check</span><svg class="sc-dntSTA dOPmTa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">object</span></div> <div><div html="<p>Time intervals between checks</p>
|
||||
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Time intervals between checks</p>
|
||||
</div></div></div></td></tr><tr class=""><td kind="field" title="time_between_check" class="sc-kCuUfV sc-fbQrwq sc-itBLYH gdmNWp dFOJWJ kdPQHX"><span class="sc-hwddKA cteAyA"></span><button aria-label="expand time_between_check"><span class="property-name">time_between_check</span><svg class="sc-dntSTA dOPmTa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">object</span></div> <div><div html="<p>Time intervals between checks. All fields must be non-negative. At least one non-zero value required when not using default settings.</p>
|
||||
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Time intervals between checks. All fields must be non-negative. At least one non-zero value required when not using default settings.</p>
|
||||
</div></div></div></td></tr><tr class=""><td kind="field" title="time_between_check_use_default" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">time_between_check_use_default</span></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">boolean</span></div><div><span class="sc-bEjUoa lhyyLL"> <!-- -->Default:<!-- --> </span> <span class="sc-bEjUoa sc-dTWiOz lhyyLL kMQdIk">true</span></div> <div><div html="<p>Whether to use global settings for time between checks - defaults to true if not set</p>
|
||||
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Whether to use global settings for time between checks - defaults to true if not set</p>
|
||||
</div></div></div></td></tr><tr class=""><td kind="field" title="notification_urls" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">notification_urls</span></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP">Array of </span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">strings</span></div> <div><div html="<p>Notification URLs for this web page change monitor (watch)</p>
|
||||
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Notification URLs for this web page change monitor (watch)</p>
|
||||
</div></div></div></td></tr><tr class=""><td kind="field" title="notification_urls" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">notification_urls</span></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP">Array of </span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">strings</span><span> <span class="sc-bEjUoa sc-goiVcJ lhyyLL bDfgbe"> <!-- --><= 100 items<!-- --> </span></span><span class="sc-bEjUoa sc-boKDdR sc-bBhMX lhyyLL jYezsP eA-DYPM">[ items<span> <span class="sc-bEjUoa sc-goiVcJ lhyyLL bDfgbe"> <!-- --><= 1000 characters<!-- --> </span></span> ]</span></div> <div><div html="<p>Notification URLs for this web page change monitor (watch). Maximum 100 URLs.</p>
|
||||
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Notification URLs for this web page change monitor (watch). Maximum 100 URLs.</p>
|
||||
</div></div></div></td></tr><tr class=""><td kind="field" title="notification_title" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">notification_title</span></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span><span> <span class="sc-bEjUoa sc-goiVcJ lhyyLL bDfgbe"> <!-- --><= 5000 characters<!-- --> </span></span></div> <div><div html="<p>Custom notification title</p>
|
||||
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Custom notification title</p>
|
||||
</div></div></div></td></tr><tr class=""><td kind="field" title="notification_body" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">notification_body</span></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span><span> <span class="sc-bEjUoa sc-goiVcJ lhyyLL bDfgbe"> <!-- --><= 5000 characters<!-- --> </span></span></div> <div><div html="<p>Custom notification body</p>
|
||||
@@ -626,8 +626,8 @@ notification preferences, and content filtering options.</p>
|
||||
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Format for notifications</p>
|
||||
</div></div></div></td></tr><tr class=""><td kind="field" title="track_ldjson_price_data" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">track_ldjson_price_data</span></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">boolean</span></div> <div><div html="<p>Whether to track JSON-LD price data</p>
|
||||
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Whether to track JSON-LD price data</p>
|
||||
</div></div></div></td></tr><tr class=""><td kind="field" title="browser_steps" class="sc-kCuUfV sc-fbQrwq sc-itBLYH gdmNWp dFOJWJ kdPQHX"><span class="sc-hwddKA cteAyA"></span><button aria-label="expand browser_steps"><span class="property-name">browser_steps</span><svg class="sc-dntSTA dOPmTa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP">Array of </span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">objects</span></div> <div><div html="<p>Browser automation steps</p>
|
||||
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Browser automation steps</p>
|
||||
</div></div></div></td></tr><tr class=""><td kind="field" title="browser_steps" class="sc-kCuUfV sc-fbQrwq sc-itBLYH gdmNWp dFOJWJ kdPQHX"><span class="sc-hwddKA cteAyA"></span><button aria-label="expand browser_steps"><span class="property-name">browser_steps</span><svg class="sc-dntSTA dOPmTa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP">Array of </span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">objects</span><span> <span class="sc-bEjUoa sc-goiVcJ lhyyLL bDfgbe"> <!-- --><= 100 items<!-- --> </span></span></div> <div><div html="<p>Browser automation steps. Maximum 100 steps allowed.</p>
|
||||
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Browser automation steps. Maximum 100 steps allowed.</p>
|
||||
</div></div></div></td></tr><tr class=""><td kind="field" title="processor" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">processor</span></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span></div><div><span class="sc-bEjUoa lhyyLL"> <!-- -->Default:<!-- --> </span> <span class="sc-bEjUoa sc-dTWiOz lhyyLL kMQdIk">"text_json_diff"</span></div><div><span class="sc-bEjUoa lhyyLL"> <!-- -->Enum<!-- -->:</span> <span class="sc-bEjUoa sc-dTWiOz lhyyLL kMQdIk">"restock_diff"</span> <span class="sc-bEjUoa sc-dTWiOz lhyyLL kMQdIk">"text_json_diff"</span> </div> <div><div html="<p>Optional processor mode to use for change detection. Defaults to <code>text_json_diff</code> if not specified.</p>
|
||||
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Optional processor mode to use for change detection. Defaults to <code>text_json_diff</code> if not specified.</p>
|
||||
</div></div></div></td></tr><tr class="last "><td kind="field" title="last_viewed" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">last_viewed</span></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">integer</span><span> <span class="sc-bEjUoa sc-goiVcJ lhyyLL bDfgbe"> <!-- -->>= 0<!-- --> </span></span></div> <div><div html="<p>Unix timestamp in seconds of the last time the watch was viewed. Setting it to a value higher than <code>last_changed</code> in the &quot;Update watch&quot; endpoint marks the watch as viewed.</p>
|
||||
@@ -642,7 +642,7 @@ notification preferences, and content filtering options.</p>
|
||||
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Production server</p>
|
||||
</div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span>https://yourdomain.com/api/v1</span>/watch/{uuid}</div></div></div><div class="sc-iyBeIh icOxsG"><div html="<p>Custom server</p>
|
||||
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Custom server</p>
|
||||
</div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span>{protocol}://{host}/api/v1</span>/watch/{uuid}</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Request samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab_R_2acha_0" aria-selected="true" aria-disabled="false" aria-controls="panel_R_2acha_0" tabindex="0" data-rttab="true">Payload</li><li class="react-tabs__tab" role="tab" id="tab_R_2acha_1" aria-selected="false" aria-disabled="false" aria-controls="panel_R_2acha_1" data-rttab="true">curl</li><li class="react-tabs__tab" role="tab" id="tab_R_2acha_2" aria-selected="false" aria-disabled="false" aria-controls="panel_R_2acha_2" data-rttab="true">Python</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel_R_2acha_0" aria-labelledby="tab_R_2acha_0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"url"</span>: <span class="token string">"</span><a href="http://example.com">http://example.com</a><span class="token string">"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"title"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"tag"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"tags"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"paused"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"notification_muted"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"method"</span>: <span class="token string">"GET"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"fetch_backend"</span>: <span class="token string">"html_requests"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"headers"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"body"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"proxy"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"webdriver_delay"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"webdriver_js_execute_code"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"time_between_check"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span cLine truncated
|
||||
</div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span>{protocol}://{host}/api/v1</span>/watch/{uuid}</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Request samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab_R_2acha_0" aria-selected="true" aria-disabled="false" aria-controls="panel_R_2acha_0" tabindex="0" data-rttab="true">Payload</li><li class="react-tabs__tab" role="tab" id="tab_R_2acha_1" aria-selected="false" aria-disabled="false" aria-controls="panel_R_2acha_1" data-rttab="true">curl</li><li class="react-tabs__tab" role="tab" id="tab_R_2acha_2" aria-selected="false" aria-disabled="false" aria-controls="panel_R_2acha_2" data-rttab="true">Python</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel_R_2acha_0" aria-labelledby="tab_R_2acha_0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"url"</span>: <span class="token string">"</span><a href="http://example.com">http://example.com</a><span class="token string">"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"title"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"tag"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"tags"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"paused"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"notification_muted"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"method"</span>: <span class="token string">"GET"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"fetch_backend"</span>: <span class="token string">"html_requests"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"headers"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"body"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"proxy"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"webdriver_delay"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"webdriver_js_execute_code"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"time_between_check"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span cLine truncated
|
||||
" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><p>Delete a web page change monitor (watch) and all related history</p>
|
||||
</div></div><div class="sc-ikkVnJ deUlC"><div class="sc-hWgKua dPSGXF"><h5 class="sc-eqYatC sc-gFqXPY czjApA jCoZLr">Authorizations:</h5><svg class="sc-dntSTA FtowP" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jBaHRL fUkQtw"><span class="sc-iVnIWt gRXavu"><span class="sc-hqtLyI hRtRoN"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-eqYatC czjApA">path<!-- --> Parameters</h5><table class="sc-eqNDNG icJLQx"><tbody><tr class="last "><td kind="field" title="uuid" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">uuid</span><div class="sc-bEjUoa sc-iIvHqT lhyyLL crXmiY">required</div></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq"> <!-- --><<!-- -->uuid<!-- -->><!-- --> </span></div> <div><div html="<p>Web page change monitor (watch) unique ID</p>
|
||||
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Web page change monitor (watch) unique ID</p>
|
||||
@@ -1066,16 +1066,48 @@ monitors in large collections or identifying watches that match certain criteria
|
||||
apply tags, proxy settings, and other configurations to all imported watches simultaneously.</p>
|
||||
"><p>Bulk import multiple URLs for monitoring. Accepts plain text lists of URLs and can automatically
|
||||
apply tags, proxy settings, and other configurations to all imported watches simultaneously.</p>
|
||||
</div></div></div><div id="tag/Import/operation/importWatches" data-section-id="tag/Import/operation/importWatches" class="sc-dTvVRJ gHrCVQ"><div data-section-id="operation/importWatches" id="operation/importWatches" class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Import/operation/importWatches" aria-label="tag/Import/operation/importWatches"></a>Import watch URLs<!-- --> </h2><div class="sc-bfjeOH txIPi"><div html="<p>Import a list of URLs to monitor. Accepts line-separated URLs in request body.</p>
|
||||
" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><p>Import a list of URLs to monitor. Accepts line-separated URLs in request body.</p>
|
||||
</div></div><div class="sc-ikkVnJ deUlC"><div class="sc-hWgKua dPSGXF"><h5 class="sc-eqYatC sc-gFqXPY czjApA jCoZLr">Authorizations:</h5><svg class="sc-dntSTA FtowP" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jBaHRL fUkQtw"><span class="sc-iVnIWt gRXavu"><span class="sc-hqtLyI hRtRoN"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-eqYatC czjApA">query<!-- --> Parameters</h5><table class="sc-eqNDNG icJLQx"><tbody><tr class=""><td kind="field" title="tag_uuids" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">tag_uuids</span></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span></div> <div><div html="<p>Tag UUID to apply to imported web page change monitors (watches)</p>
|
||||
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Tag UUID to apply to imported web page change monitors (watches)</p>
|
||||
</div></div></div></td></tr><tr class=""><td kind="field" title="tag" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">tag</span></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span></div> <div><div html="<p>Tag name to apply to imported web page change monitors (watches)</p>
|
||||
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Tag name to apply to imported web page change monitors (watches)</p>
|
||||
</div></div></div></td></tr><tr class=""><td kind="field" title="proxy" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">proxy</span></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span></div> <div><div html="<p>Proxy key to use for imported web page change monitors (watches)</p>
|
||||
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Proxy key to use for imported web page change monitors (watches)</p>
|
||||
</div></div></div></td></tr><tr class="last "><td kind="field" title="dedupe" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">dedupe</span></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">boolean</span></div><div><span class="sc-bEjUoa lhyyLL"> <!-- -->Default:<!-- --> </span> <span class="sc-bEjUoa sc-dTWiOz lhyyLL kMQdIk">true</span></div> <div><div html="<p>Remove duplicate URLs (default true)</p>
|
||||
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Remove duplicate URLs (default true)</p>
|
||||
</div></div></div><div id="tag/Import/operation/importWatches" data-section-id="tag/Import/operation/importWatches" class="sc-dTvVRJ gHrCVQ"><div data-section-id="operation/importWatches" id="operation/importWatches" class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Import/operation/importWatches" aria-label="tag/Import/operation/importWatches"></a>Import watch URLs with configuration<!-- --> </h2><div class="sc-bfjeOH txIPi"><div html="<p>Import a list of URLs to monitor with optional watch configuration. Accepts line-separated URLs in request body.</p>
|
||||
<p><strong>Configuration via Query Parameters:</strong></p>
|
||||
<p>You can pass ANY watch configuration field as query parameters to apply settings to all imported watches.
|
||||
All parameters from the Watch schema are supported (processor, fetch_backend, notification_urls, etc.).</p>
|
||||
<p><strong>Special Parameters:</strong></p>
|
||||
<ul>
|
||||
<li><code>tag</code> / <code>tag_uuids</code> - Assign tags to imported watches</li>
|
||||
<li><code>proxy</code> - Use specific proxy for imported watches</li>
|
||||
<li><code>dedupe</code> - Skip duplicate URLs (default: true)</li>
|
||||
</ul>
|
||||
<p><strong>Type Conversion:</strong></p>
|
||||
<ul>
|
||||
<li>Booleans: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>, <code>yes</code>, <code>no</code></li>
|
||||
<li>Arrays: Comma-separated or JSON format (<code>[item1,item2]</code>)</li>
|
||||
<li>Objects: JSON format (<code>{&quot;key&quot;:&quot;value&quot;}</code>)</li>
|
||||
<li>Numbers: Parsed as int or float</li>
|
||||
</ul>
|
||||
" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><p>Import a list of URLs to monitor with optional watch configuration. Accepts line-separated URLs in request body.</p>
|
||||
<p><strong>Configuration via Query Parameters:</strong></p>
|
||||
<p>You can pass ANY watch configuration field as query parameters to apply settings to all imported watches.
|
||||
All parameters from the Watch schema are supported (processor, fetch_backend, notification_urls, etc.).</p>
|
||||
<p><strong>Special Parameters:</strong></p>
|
||||
<ul>
|
||||
<li><code>tag</code> / <code>tag_uuids</code> - Assign tags to imported watches</li>
|
||||
<li><code>proxy</code> - Use specific proxy for imported watches</li>
|
||||
<li><code>dedupe</code> - Skip duplicate URLs (default: true)</li>
|
||||
</ul>
|
||||
<p><strong>Type Conversion:</strong></p>
|
||||
<ul>
|
||||
<li>Booleans: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>, <code>yes</code>, <code>no</code></li>
|
||||
<li>Arrays: Comma-separated or JSON format (<code>[item1,item2]</code>)</li>
|
||||
<li>Objects: JSON format (<code>{"key":"value"}</code>)</li>
|
||||
<li>Numbers: Parsed as int or float</li>
|
||||
</ul>
|
||||
</div></div><div class="sc-ikkVnJ deUlC"><div class="sc-hWgKua dPSGXF"><h5 class="sc-eqYatC sc-gFqXPY czjApA jCoZLr">Authorizations:</h5><svg class="sc-dntSTA FtowP" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jBaHRL fUkQtw"><span class="sc-iVnIWt gRXavu"><span class="sc-hqtLyI hRtRoN"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-eqYatC czjApA">query<!-- --> Parameters</h5><table class="sc-eqNDNG icJLQx"><tbody><tr class=""><td kind="field" title="tag_uuids" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">tag_uuids</span></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span></div> <div><span class="sc-bEjUoa lhyyLL"> <!-- -->Example:<!-- --> </span> <span class="sc-bEjUoa sc-dTWiOz lhyyLL kMQdIk">tag_uuids=550e8400-e29b-41d4-a716-446655440000</span></div><div><div html="<p>Tag UUID(s) to apply to imported watches (comma-separated for multiple)</p>
|
||||
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Tag UUID(s) to apply to imported watches (comma-separated for multiple)</p>
|
||||
</div></div></div></td></tr><tr class=""><td kind="field" title="tag" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">tag</span></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span></div> <div><span class="sc-bEjUoa lhyyLL"> <!-- -->Example:<!-- --> </span> <span class="sc-bEjUoa sc-dTWiOz lhyyLL kMQdIk">tag=production</span></div><div><div html="<p>Tag name to apply to imported watches</p>
|
||||
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Tag name to apply to imported watches</p>
|
||||
</div></div></div></td></tr><tr class=""><td kind="field" title="proxy" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">proxy</span></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span></div> <div><span class="sc-bEjUoa lhyyLL"> <!-- -->Example:<!-- --> </span> <span class="sc-bEjUoa sc-dTWiOz lhyyLL kMQdIk">proxy=proxy1</span></div><div><div html="<p>Proxy key to use for imported watches</p>
|
||||
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Proxy key to use for imported watches</p>
|
||||
</div></div></div></td></tr><tr class="last "><td kind="field" title="dedupe" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">dedupe</span></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">boolean</span></div><div><span class="sc-bEjUoa lhyyLL"> <!-- -->Default:<!-- --> </span> <span class="sc-bEjUoa sc-dTWiOz lhyyLL kMQdIk">true</span></div> <div><div html="<p>Skip duplicate URLs (default true)</p>
|
||||
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Skip duplicate URLs (default true)</p>
|
||||
</div></div></div></td></tr></tbody></table></div><h5 class="sc-eqYatC czjApA">Request Body schema: <span class="sc-dNFkOE cFlAeY">text/plain</span><div class="sc-bEjUoa sc-iIvHqT sc-eTCgfj lhyyLL crXmiY foplsk">required</div></h5><div html="" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"></div><div><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span></div> <div><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div></div></div></div><div><h3 class="sc-gDzyrw kjrVcG">Responses</h3><div><button class="sc-jIDBmd lkmdtA"><svg class="sc-dntSTA cGxVlA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">200<!-- --> </strong><div html="<p>URLs imported successfully</p>
|
||||
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>URLs imported successfully</p>
|
||||
</div></button></div><div><button class="sc-jIDBmd kQCDrg" disabled=""><strong class="sc-eJvlPh fBhAXU">500<!-- --> </strong><div html="<p>Server error</p>
|
||||
@@ -1107,7 +1139,7 @@ counts, uptime information, and version details.</p>
|
||||
<span class="token operator">-</span>H <span class="token string">"x-api-key: YOUR_API_KEY"</span>
|
||||
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel_R_ijla_1" aria-labelledby="tab_R_ijla_1"></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab_R_jjla_0" aria-selected="true" aria-disabled="false" aria-controls="panel_R_jjla_0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel_R_jjla_0" aria-labelledby="tab_R_jjla_0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"watch_count"</span>: <span class="token number">42</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"tag_count"</span>: <span class="token number">5</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"uptime"</span>: <span class="token string">"2 days, 3:45:12"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"version"</span>: <span class="token string">"0.50.10"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div></div><div class="sc-evkzZa iZqpqg"></div></div></div>
|
||||
<script>
|
||||
const __redoc_state = {"menu":{"activeItemIdx":-1},"spec":{"data":{"openapi":"3.1.0","info":{"title":"ChangeDetection.io API","description":"# ChangeDetection.io Web page monitoring and notifications API\n\nREST API for managing Page watches, Group tags, and Notifications.\n\nchangedetection.io can be driven by its built in simple API, in the examples below you will also find `curl` command line and `python` examples to help you get started faster.\n\n## Where to find my API key?\n\nThe API key can be easily found under the **SETTINGS** then **API** tab of changedetection.io dashboard. \nSimply click the API key to automatically copy it to your clipboard.\n\n\n\n## Connection URL\n\nThe API can be found at `/api/v1/`, so for example if you run changedetection.io locally on port 5000, then URL would be `http://localhost:5000/api/v1/watch/cc0cfffa-f449-477b-83ea-0caafd1dc091/history`.\n\nIf you are using the hosted/subscription version of changedetection.io, then the URL is based on your login URL, for example: \n`https://<your login url>/api/v1/watch/cc0cfffa-f449-477b-83ea-0caafd1dc091/history`\n\n## Authentication\n\nAlmost all API requests require some authentication, this is provided as an **API Key** in the header of the HTTP request.\n\nFor example: `x-api-key: YOUR_API_KEY`\n","version":"0.1.4","contact":{"name":"ChangeDetection.io","url":"https://github.com/dgtlmoon/changedetection.io"},"license":{"name":"Apache 2.0","url":"https://www.apache.org/licenses/LICENSE-2.0.html"}},"servers":[{"url":"http://localhost:5000/api/v1","description":"Development server"},{"url":"https://yourdomain.com/api/v1","description":"Production server"},{"url":"{protocol}://{host}/api/v1","description":"Custom server","variables":{"protocol":{"enum":["http","https"],"default":"https"},"host":{"default":"yourdomain.com","description":"Your changedetection.io host"}}}],"security":[{"ApiKeyAuth":[]}],"tags":[{"name":"Watch Management","description":"Core functionality for managing web page monitors. Create, retrieve, update, and delete individual watches. \nEach watch represents a single URL being monitored for changes, with configurable settings for check intervals, \nnotification preferences, and content filtering options.\n"},{"name":"Watch History","description":"Get a list of timestamps of all changes detected for a watch.\n"},{"name":"Snapshots","description":"Retrieve individual text snapshot of monitored content according to the `timestamp`. The text snapshot is the HTML\nto Text at page check time. \n\nSet the query argument `html` to any value to retrieve the last HTML fetched, the system only keeps the last two \n(2) HTML files fetched.\n\nUse the Watch History API endpoint to get a list of timestamps to pass to this query.\n"},{"name":"Favicon","description":"Retrieve favicon images associated with monitored web pages. These are used in the dashboard interface \nto visually identify different watches in your monitoring list.\n"},{"name":"Group / Tag Management","description":"Organize your watches using tags and groups. Tags (also known as Groups) allow you to categorize monitors, set group-wide \nnotification preferences, and perform bulk operations like mass rechecking or status changes across \nmultiple related watches.\n"},{"name":"Notifications","description":"Configure global notification endpoints that can be used across all your watches. Supports various \nnotification services including email, Discord, Slack, webhooks, and many other popular platforms. \nThese settings serve as defaults that can be overridden at the individual watch or tag level.\n\nThe notification syntax uses [https://github.com/caronc/apprise](https://github.com/caronc/apprise).\n"},{"name":"Search","description":"Search and filter your watches by URL patterns, titles, or tags. Useful for quickly finding specific \nmonitors in large collections or identifying watches that match certain criteria.\n"},{"name":"Import","description":"Bulk import multiple URLs for monitoring. Accepts plain text lists of URLs and can automatically \napply tags, proxy settings, and other configurations to all imported watches simultaneously.\n"},{"name":"System Information","description":"Retrieve system status and statistics about your changedetection.io instance, including total watch \ncounts, uptime information, and version details.\n"}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key","description":"API key for authentication. You can find your API key in the changedetection.io dashboard under Settings > API.\n\nEnter your API key in the \"Authorize\" button above to automatically populate all code examples.\n"}},"schemas":{"WatchBase":{"type":"object","properties":{"url":{"type":"string","format":"uri","description":"URL to monitor for changes","maxLength":5000},"title":{"type":"string","description":"Custom title for the web page change monLine truncated
|
||||
const __redoc_state = {"menu":{"activeItemIdx":-1},"spec":{"data":{"openapi":"3.1.0","info":{"title":"ChangeDetection.io API","description":"# ChangeDetection.io Web page monitoring and notifications API\n\nREST API for managing Page watches, Group tags, and Notifications.\n\nchangedetection.io can be driven by its built in simple API, in the examples below you will also find `curl` command line and `python` examples to help you get started faster.\n\n## Where to find my API key?\n\nThe API key can be easily found under the **SETTINGS** then **API** tab of changedetection.io dashboard. \nSimply click the API key to automatically copy it to your clipboard.\n\n\n\n## Connection URL\n\nThe API can be found at `/api/v1/`, so for example if you run changedetection.io locally on port 5000, then URL would be `http://localhost:5000/api/v1/watch/cc0cfffa-f449-477b-83ea-0caafd1dc091/history`.\n\nIf you are using the hosted/subscription version of changedetection.io, then the URL is based on your login URL, for example: \n`https://<your login url>/api/v1/watch/cc0cfffa-f449-477b-83ea-0caafd1dc091/history`\n\n## Authentication\n\nAlmost all API requests require some authentication, this is provided as an **API Key** in the header of the HTTP request.\n\nFor example: `x-api-key: YOUR_API_KEY`\n","version":"0.1.5","contact":{"name":"ChangeDetection.io","url":"https://github.com/dgtlmoon/changedetection.io"},"license":{"name":"Apache 2.0","url":"https://www.apache.org/licenses/LICENSE-2.0.html"}},"servers":[{"url":"http://localhost:5000/api/v1","description":"Development server"},{"url":"https://yourdomain.com/api/v1","description":"Production server"},{"url":"{protocol}://{host}/api/v1","description":"Custom server","variables":{"protocol":{"enum":["http","https"],"default":"https"},"host":{"default":"yourdomain.com","description":"Your changedetection.io host"}}}],"security":[{"ApiKeyAuth":[]}],"tags":[{"name":"Watch Management","description":"Core functionality for managing web page monitors. Create, retrieve, update, and delete individual watches. \nEach watch represents a single URL being monitored for changes, with configurable settings for check intervals, \nnotification preferences, and content filtering options.\n"},{"name":"Watch History","description":"Get a list of timestamps of all changes detected for a watch.\n"},{"name":"Snapshots","description":"Retrieve individual text snapshot of monitored content according to the `timestamp`. The text snapshot is the HTML\nto Text at page check time. \n\nSet the query argument `html` to any value to retrieve the last HTML fetched, the system only keeps the last two \n(2) HTML files fetched.\n\nUse the Watch History API endpoint to get a list of timestamps to pass to this query.\n"},{"name":"Favicon","description":"Retrieve favicon images associated with monitored web pages. These are used in the dashboard interface \nto visually identify different watches in your monitoring list.\n"},{"name":"Group / Tag Management","description":"Organize your watches using tags and groups. Tags (also known as Groups) allow you to categorize monitors, set group-wide \nnotification preferences, and perform bulk operations like mass rechecking or status changes across \nmultiple related watches.\n"},{"name":"Notifications","description":"Configure global notification endpoints that can be used across all your watches. Supports various \nnotification services including email, Discord, Slack, webhooks, and many other popular platforms. \nThese settings serve as defaults that can be overridden at the individual watch or tag level.\n\nThe notification syntax uses [https://github.com/caronc/apprise](https://github.com/caronc/apprise).\n"},{"name":"Search","description":"Search and filter your watches by URL patterns, titles, or tags. Useful for quickly finding specific \nmonitors in large collections or identifying watches that match certain criteria.\n"},{"name":"Import","description":"Bulk import multiple URLs for monitoring. Accepts plain text lists of URLs and can automatically \napply tags, proxy settings, and other configurations to all imported watches simultaneously.\n"},{"name":"System Information","description":"Retrieve system status and statistics about your changedetection.io instance, including total watch \ncounts, uptime information, and version details.\n"}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key","description":"API key for authentication. You can find your API key in the changedetection.io dashboard under Settings > API.\n\nEnter your API key in the \"Authorize\" button above to automatically populate all code examples.\n"}},"schemas":{"WatchBase":{"type":"object","properties":{"url":{"type":"string","format":"uri","description":"URL to monitor for changes","maxLength":5000},"title":{"type":"string","description":"Custom title for the web page change monLine truncated
|
||||
|
||||
var container = document.getElementById('redoc');
|
||||
Redoc.hydrate(__redoc_state, container);
|
||||
|
||||
Reference in new issue
Block a user