Document apiReferenceTrack changes

trackChanges.list

List tracked changes in the document. Body-only by default; pass `in: StoryLocator` or `in: "all"` to widen scope.

read-onlyidempotent
doc.trackChanges.list(…)

Expected result

Returns a TrackChangesListResult of logical tracked-change entries with SuperDoc ids, semantic type/subtype, author/date/excerpt, revisionGroupId, flat projection fields (`grouping`, `insertedText`, `deletedText`, `formattingDeltaSummary`, `origin`, `imported`, `canonicalizationKind`, `addressKind`, `resolvableById`), optional overlap metadata, and source provenance via `sourceIds` / `wordRevisionIds`. Structural whole-table changes surface subtypes such as `table-insert` and `table-delete`.

Inputs

limitinteger

Maximum number of tracked changes to return.

offsetinteger

Number of tracked changes to skip for pagination.

type"insertion" | "deletion" | "replacement" | "formatting" | "move" | "structural" | "insert" | "delete" | "format"

Filter by change type. Canonical values: 'insertion', 'deletion', 'replacement', 'formatting', 'move', 'structural'. Legacy aliases 'insert', 'delete', and 'format' remain accepted during migration.

inStoryLocator | "all"

Story scope. Omit for body only, pass a StoryLocator for a single story, or 'all' for body + every revision-capable non-body story.

body / headerFooterSlot / headerFooterPart / footnote / endnote / textbox
body
kind"story"required
storyType"body"required
headerFooterSlot
kind"story"required
storyType"headerFooterSlot"required
sectionSectionAddressrequired
headerFooterKind"header" | "footer"required
variant"default" | "first" | "even"required
resolution"effective" | "explicit"
onWrite"materializeIfInherited" | "editResolvedPart" | "error"
headerFooterPart
kind"story"required
storyType"headerFooterPart"required
refIdstringrequired
footnote
kind"story"required
storyType"footnote"required
noteIdstringrequired
endnote
kind"story"required
storyType"endnote"required
noteIdstringrequired
textbox
kind"story"required
storyType"textbox"required
textboxIdstringrequired
Variant 2

No fields.

Result

Output fields
evaluatedRevisionstringrequired
totalintegerrequired
itemsobject[]required
pagePageInforequired
Fields
limitintegerrequired
offsetintegerrequired
returnedintegerrequired

Failures

Pre-apply throws

  • INVALID_INPUT

Raw schemas

Open the generated JSON artifact for the exact input, output, success, and failure schemas represented by this contract version.

View raw JSON schemas