diff --git a/docs/api-spec.yaml b/docs/api-spec.yaml index 9ba80222d..b064352ff 100644 --- a/docs/api-spec.yaml +++ b/docs/api-spec.yaml @@ -28,7 +28,7 @@ info: For example: `x-api-key: YOUR_API_KEY` - version: 0.1.2 + version: 0.1.3 contact: name: ChangeDetection.io url: https://github.com/dgtlmoon/changedetection.io @@ -65,13 +65,17 @@ tags: - name: Watch History description: | - 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. + Get a list of timestamps of all changes detected for a watch. - name: Snapshots description: | - Retrieve individual snapshots of monitored content. Access both the processed change detection data and - the raw HTML content that was captured during monitoring checks. + Retrieve individual text snapshot of monitored content according to the `timestamp`. The text snapshot is the HTML + to Text at page check time. + + Set the query argument `html` to any value to retrieve the last HTML fetched, the system only keeps the last two + (2) HTML files fetched. + + Use the Watch History API endpoint to get a list of timestamps to pass to this query. - name: Favicon description: | @@ -661,7 +665,9 @@ paths: operationId: getWatchHistory tags: [Watch History] summary: Get watch history - description: Get a list of all historical snapshots available for a web page change monitor (watch) + description: | + Get a list of all historical snapshots available for a web page change monitor (watch), use the key `timestamp` + as the query argument for fetching a single watch history snapshot. x-code-samples: - lang: 'curl' source: | @@ -701,7 +707,9 @@ paths: operationId: getWatchSnapshot tags: [Snapshots] summary: Get single snapshot - description: Get single snapshot from web page change monitor (watch). Use 'latest' for the most recent snapshot. + description: | + Get single snapshot from web page change monitor (watch). Use 'latest' for the most recent snapshot. + Use the Watch History API to get a list of timestamps to pass. x-code-samples: - lang: 'curl' source: | diff --git a/docs/api_v1/index.html b/docs/api_v1/index.html index 928862f5b..d3dfafc78 100644 --- a/docs/api_v1/index.html +++ b/docs/api_v1/index.html @@ -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">

ChangeDetection.io API (0.1.2)

Download OpenAPI specification:

URL: https://github.com/dgtlmoon/changedetection.io License: Apache 2.0

ChangeDetection.io Web page monitoring and notifications API

ChangeDetection.io API (0.1.3)

Download OpenAPI specification:

URL: https://github.com/dgtlmoon/changedetection.io License: Apache 2.0

ChangeDetection.io Web page monitoring and notifications API

REST API for managing Page watches, Group tags, and Notifications.

changedetection.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.

@@ -656,12 +656,12 @@ notification preferences, and content filtering options.

" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr">

Custom server

{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.

-

Get watch history

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

+

Watch History

Get a list of timestamps of all changes detected for a watch.

+

Get watch history

Get a list of all historical snapshots available for a web page change monitor (watch), use the key timestamp +as the query argument for fetching a single watch history snapshot.

Authorizations:
ApiKeyAuth
path Parameters
uuid
required
string <uuid>

Web page change monitor (watch) unique ID

Responses

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.

+

Response samples

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

Snapshots

Retrieve individual text snapshot of monitored content according to the timestamp. The text snapshot is the HTML +to Text at page check time.

+

Set the query argument html to any value to retrieve the last HTML fetched, the system only keeps the last two +(2) HTML files fetched.

+

Use the Watch History API endpoint to get a list of timestamps to pass to this query.

+

Get single snapshot

Get single snapshot from web page change monitor (watch). Use 'latest' for the most recent snapshot. +Use the Watch History API to get a list of timestamps to pass.

Authorizations:
ApiKeyAuth
path Parameters
uuid
required
string <uuid>

Web page change monitor (watch) unique ID

required
integer or string
-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"
}