diff --git a/docs/api_v1/index.html b/docs/api_v1/index.html index 365e4fce..3c5babe4 100644 --- a/docs/api_v1/index.html +++ b/docs/api_v1/index.html @@ -432,7 +432,7 @@ data-styled.g138[id="sc-enPhjR"]{content:"SikXG,"}/*!sc*/ -
API docs by Redocly
API docs by Redocly
{protocol}://{host}/api/v1/watch/{uuid}

Request samples 

curl -X DELETE "http://localhost:5000/api/v1/watch/095be615-a8ad-4c33-8e9c-c7612fbf6c9f" \
   -H "x-api-key: YOUR_API_KEY"

Watch History

Access historical snapshots and change data for your watches. View the complete timeline of detected changes -and retrieve specific versions of monitored content for comparison and analysis.

+and retrieve specific versions of monitored content for comparison and analysis. +View differences between snapshot versions (timestamps).

Get watch history

Get a list of all historical snapshots available for a web page change monitor (watch)

Authorizations:
ApiKeyAuth
path Parameters
uuid
required
string <uuid>

Production server

https://yourdomain.com/api/v1/watch/{uuid}/history

Custom server

-
{protocol}://{host}/api/v1/watch/{uuid}/history

Request samples 

curl -X GET "http://localhost:5000/api/v1/watch/095be615-a8ad-4c33-8e9c-c7612fbf6c9f/history" \
+
{protocol}://{host}/api/v1/watch/{uuid}/history

Request samples 

curl -X GET "http://localhost:5000/api/v1/watch/095be615-a8ad-4c33-8e9c-c7612fbf6c9f/history" \
   -H "x-api-key: YOUR_API_KEY"
-

Response samples

Content type
application/json
{
  • "1640995200": "/path/to/snapshot1.txt",
  • "1640998800": "/path/to/snapshot2.txt"
}

Snapshots

Retrieve individual snapshots of monitored content. Access both the processed change detection data and -the raw HTML content that was captured during monitoring checks.

-

Get single snapshot

Get single snapshot from web page change monitor (watch). Use 'latest' for the most recent snapshot.

-
Authorizations:
ApiKeyAuth
path Parameters
uuid
required
string <uuid>

Web page change monitor (watch) unique ID

-
required
integer or string

Snapshot timestamp or 'latest'

-
query Parameters
html
string
Value: "1"

Set to 1 to return the last HTML

-

Responses

Request samples 

curl -X GET "http://localhost:5000/api/v1/watch/095be615-a8ad-4c33-8e9c-c7612fbf6c9f/history/latest" \
-  -H "x-api-key: YOUR_API_KEY"
-

Get diff between two snapshots

Response samples

Content type
application/json
{
  • "1640995200": "/path/to/snapshot1.txt",
  • "1640998800": "/path/to/snapshot2.txt"
}

Get diff between two snapshots

Production server

https://yourdomain.com/api/v1/watch/{uuid}/difference/{from_timestamp}/{to_timestamp}

Custom server

-
{protocol}://{host}/api/v1/watch/{uuid}/difference/{from_timestamp}/{to_timestamp}

Request samples 

# Compare previous snapshot to latest with colored HTML
+
{protocol}://{host}/api/v1/watch/{uuid}/difference/{from_timestamp}/{to_timestamp}

Request samples 

# Compare previous snapshot to latest with colored HTML
 curl -X GET "http://localhost:5000/api/v1/watch/095be615-a8ad-4c33-8e9c-c7612fbf6c9f/difference/previous/latest?format=htmlcolor" \
   -H "x-api-key: YOUR_API_KEY"
 
 # Compare two specific timestamps in plain text with word-level diff
 curl -X GET "http://localhost:5000/api/v1/watch/095be615-a8ad-4c33-8e9c-c7612fbf6c9f/difference/1640995200/1640998800?format=text&word_diff=true" \
   -H "x-api-key: YOUR_API_KEY"
-

Favicon

Snapshots

Retrieve individual snapshots of monitored content. Access both the processed change detection data and +the raw HTML content that was captured during monitoring checks.

+

Get single snapshot

Get single snapshot from web page change monitor (watch). Use 'latest' for the most recent snapshot.

+
Authorizations:
ApiKeyAuth
path Parameters
uuid
required
string <uuid>

Web page change monitor (watch) unique ID

+
required
integer or string

Snapshot timestamp or 'latest'

+
query Parameters
html
string
Value: "1"

Set to 1 to return the last HTML

+

Responses

Request samples 

curl -X GET "http://localhost:5000/api/v1/watch/095be615-a8ad-4c33-8e9c-c7612fbf6c9f/history/latest" \
+  -H "x-api-key: YOUR_API_KEY"
+

Favicon

Retrieve favicon images associated with monitored web pages. These are used in the dashboard interface to visually identify different watches in your monitoring list.

@@ -1005,7 +1007,7 @@ counts, uptime information, and version details.

-H "x-api-key: YOUR_API_KEY"

Response samples

Content type
application/json
{
  • "watch_count": 42,
  • "tag_count": 5,
  • "uptime": "2 days, 3:45:12",
  • "version": "0.50.10"
}