Website Watcher

Create Watch

Create a website watch job and subscription.

This endpoint monitors a website for new documents matching the description. Multiple requests for the same URL + description will share a single watch job.

Args: request: Watch configuration including URL, description, and data point to extract

Returns: WatchResponse with subscription_id and watch job status

post/api/v1/watch

Request

  • Base URL: https://api.usesieve.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.usesieve.com/api/v1/watch
  • Auth: HTTP bearer

Request body

urlstring required

Website URL to monitor

descriptionstring required

Description of document to find

data_pointstring required

Data point to extract from document

fiscal_periodstring nullable

Fiscal period (e.g., 'FY 2024', 'Q1 2024')

document_type'pdf' | 'html' | 'any'

Document type filter

waitingboolean

True=continuous monitoring, False=one-time scrape

start_datestring date nullable

Start date for monitoring (default: today)

end_datestring date nullable

End date for monitoring (default: start + 7 days)

poll_intervalnumber

Poll interval in seconds (min 0.1)

callback_urlstring nullable

Webhook URL for result notification

Response

Successful Response

subscription_idstring required
watch_job_idstring required
status'pending' | 'navigating' | 'monitoring' | 'found' | 'extracting' | 'processing' | 'completed' | 'failed' | 'expired' required

Status states for watch jobs.

resultobject nullable

Changes

No recorded changes to this operation across all 1 revision of this API.