diff --git a/docs/api-spec.yaml b/docs/api-spec.yaml index 68a366fa6..15eb252ff 100644 --- a/docs/api-spec.yaml +++ b/docs/api-spec.yaml @@ -761,9 +761,9 @@ paths: get: operationId: getWatchHistoryDiff tags: [Watch History] - summary: Get diff between two snapshots + summary: Get the difference between two snapshots description: | - Generate a formatted diff (comparison) between two historical snapshots of a web page change monitor (watch). + Generate a difference (comparison) between two historical snapshots of a web page change monitor (watch). This endpoint compares content between two points in time and returns the differences in your chosen format. Perfect for reviewing what changed between specific versions or comparing recent changes. diff --git a/docs/api_v1/index.html b/docs/api_v1/index.html index b2bc5e98c..7e4915a1d 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

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" \
   -H "x-api-key: YOUR_API_KEY"
-

Response samples

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

Get diff between two snapshots

Response samples

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

Get the difference between two snapshots

Generate a formatted diff (comparison) between two historical snapshots of a web page change monitor (watch).

+" class="sc-eVqvcJ sc-fszimp kIppRw kbZred">

Generate a difference (comparison) between two historical snapshots of a web page change monitor (watch).

This endpoint compares content between two points in time and returns the differences in your chosen format. Perfect for reviewing what changed between specific versions or comparing recent changes.

Timestamp Keywords:

@@ -1107,7 +1107,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"
}