Skip to main content
POST
web.monitor.change.read

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
ref
string
required

The ref returned by web.monitor.changes.

Pattern: ^(ref_[0-9A-HJKMNP-TV-Z]{26}|rh_[A-Za-z0-9_-]{24,1024})$

Response

The result

title
string
required

Change title.

summary
string
required

Change summary.

detectedAt
string
required

Detection time, ISO 8601.

url
string
required

Public source URL.

tags
string[]
required

Caller labels.

truncated
boolean
required

True if content or URL samples were cut.

beforeRef
string

Handle of this row. Pass it as ref to web.monitor.version.get.

afterRef
string

Handle of this row. Pass it as ref to web.monitor.version.get.

monitorRef
string

Handle of this row. Pass it as ref to web.monitor.delete or web.monitor.events.

runRef
string

Handle of this row. Pass it as ref to data.monitor.run.read.

importance
enum<string>

Importance of the page change.

Available options:
low,
medium,
high
confidence
number

Confidence in the page change.

Required range: 0 <= x <= 1
diff
string

Bounded text diff.

beforeText
string

Text before the change.

afterText
string

Text after the change.

addedUrls
string[]

Added URL samples, at most 500.

removedUrls
string[]

Removed URL samples, at most 500.

matchedUrls
string[]

Matched URL samples, at most 500.

addedUrlCount
integer

Exact number of added URLs.

Required range: 0 <= x <= 9007199254740991
removedUrlCount
integer

Exact number of removed URLs.

Required range: 0 <= x <= 9007199254740991
matchedUrlCount
integer

Exact number of matched URLs.

Required range: 0 <= x <= 9007199254740991
evidence
object[]

Supporting evidence.