Skip to main content
GET
cURL

Authorizations

x-api-key
string
header
required

API key for authentication. You can find your API key in the Site Spy dashboard under Settings → API.

Path Parameters

uuid
string<uuid>
required

Web page change monitor (watch) unique ID

from_timestamp
required

Starting snapshot timestamp, 'previous' for second-most-recent, or specific Unix timestamp Unix timestamp of the starting snapshot

to_timestamp
required

Ending snapshot timestamp, 'latest' for most recent, or specific Unix timestamp Unix timestamp of the ending snapshot

Query Parameters

format
enum<string>
default:text

Output format for the diff:

  • text (default): Plain text with (removed) and (added) prefixes
  • html: Basic HTML format
  • htmlcolor: Rich HTML with colored backgrounds (red for deletions, green for additions)
  • markdown: Markdown format with HTML rendering
Available options:
text,
html,
htmlcolor,
markdown
word_diff
enum<string>
default:false

Enable word-level diffing for more granular comparisons. When enabled, changes are highlighted at the word level rather than line level. Default is false (line-level mode). Accepts: true, false, 1, 0, yes, no, on, off

Available options:
true,
false,
1,
0,
yes,
no,
on,
off
no_markup
enum<string>
default:false

When set to true, returns the raw diff content without any markup formatting. The content will include placeholders for opening/closing tags of the changes, allowing you to implement your own custom colorisation or formatting. This skips all HTML color application and service tweaks. Accepts: true, false, 1, 0, yes, no, on, off

Available options:
true,
false,
1,
0,
yes,
no,
on,
off
type
enum<string>
default:diffLines

Diff granularity type:

  • diffLines (default): Line-level comparison, showing which lines changed
  • diffWords: Word-level comparison, showing which words changed within lines

This parameter is an alternative to word_diff for better alignment with the UI. If both are specified, type=diffWords will enable word-level diffing.

Available options:
diffLines,
diffWords
changesOnly
enum<string>
default:true

When enabled, only show lines/content that changed (no surrounding context). When disabled, include unchanged lines for context around changes. Accepts: true, false, 1, 0, yes, no, on, off

Available options:
true,
false,
1,
0,
yes,
no,
on,
off
ignoreWhitespace
enum<string>
default:false

When enabled, ignore whitespace-only changes (spaces, tabs, newlines). Useful for focusing on content changes and ignoring formatting differences. Accepts: true, false, 1, 0, yes, no, on, off

Available options:
true,
false,
1,
0,
yes,
no,
on,
off
removed
enum<string>
default:true

Include removed/deleted content in the diff output. When disabled, content that was deleted will not appear in the diff. Accepts: true, false, 1, 0, yes, no, on, off

Available options:
true,
false,
1,
0,
yes,
no,
on,
off
added
enum<string>
default:true

Include added/new content in the diff output. When disabled, content that was added will not appear in the diff. Accepts: true, false, 1, 0, yes, no, on, off

Available options:
true,
false,
1,
0,
yes,
no,
on,
off
replaced
enum<string>
default:true

Include replaced/modified content in the diff output. When disabled, content that was modified (changed from one value to another) will not appear in the diff. Accepts: true, false, 1, 0, yes, no, on, off

Available options:
true,
false,
1,
0,
yes,
no,
on,
off

Response

Formatted diff between the two snapshots

Plain text diff with change markers