Skip to main content
GET
JavaScript
0 Credits

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <API_KEY>, where <API_KEY> is your api key.

Path Parameters

change_id
string
required
Example:

"chg_123"

Response

Change details

A detected change. mode is the constant web; target_type and change_detection_type describe the change, and which optional fields are present depends on them (page: diff + excerpts; sitemap: added_urls/removed_urls; semantic: confidence/importance/evidence/matched_urls).

mode
enum<string>
required

Top-level monitor category. Always web today; the concrete behavior is described by target and change_detection.

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

User-defined tags for grouping and filtering monitors and their changes. Duplicates are removed.

Maximum array length: 20
Required string length: 1 - 50
Example:
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[]