Skip to main content
GET
Retrieve a monitor change
0 credits Requires monitors:read permission. See the guide for examples and usage.

Authorizations

Authorization
string
header
required

Send Authorization: Bearer <API_KEY>. Keys have full access unless restricted to scopes.

Path Parameters

change_id
string
required

ID of the detected change.

Example:

"chg_123"

Response

Change details

mode
enum<string>
required

Always web. Optional.

Available options:
web
id
string
required
Example:

"chg_123"

monitor_id
string
required
Example:

"mon_123"

run_id
string
required

The run that detected this change.

Example:

"run_123"

target_type
enum<string>
required
Available options:
page,
sitemap,
extract
change_detection_type
enum<string>
required
Available options:
exact,
semantic
title
string
required
Example:

"Acme pricing page changed"

summary
string
required
Example:

"The visible text on the page changed."

detected_at
string<date-time>
required
url
string<uri>
required
tags
string[]
required

Labels for filtering monitors, their changes, and their usage.

Maximum array length: 20
Required string length: 1 - 50
Example:
request_id
string<uuid>
required

Unique ID of this request, also in X-Request-Id. Include it when contacting support.

Example:

"3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91"

importance
enum<string>
Available options:
low,
medium,
high
confidence
number
Required range: 0 <= x <= 1
diff
string

Text diff between the previous and current page baseline (page targets).

before_text_excerpt
string
after_text_excerpt
string
added_urls
string<uri>[]

At most 500 URLs are included; the corresponding count field is always exact.

removed_urls
string<uri>[]

At most 500 URLs are included; the corresponding count field is always exact.

added_url_count
integer
Required range: x >= 0
removed_url_count
integer
Required range: x >= 0
matched_urls
string<uri>[]

At most 500 URLs are included; the corresponding count field is always exact.

matched_url_count
integer
Required range: x >= 0
evidence
object[]
key_metadata
object

Credits this request used and your remaining balance.