About the Comment Content Revisions API

The Comment Content Revisions API retrieves earlier versions of a comment's rich content.

With the Comment Content Revisions API, you can:

• List the saved earlier content versions of a comment.
• Build an edit-history view alongside the comment's current content.

A revision is a saved earlier content version, not the current comment object or its optimistic-concurrency revision number. Read the current content using the Comments API. The history response can contain no revisions for a comment that has not yet produced a saved earlier version.

Before you begin

It's important to note the following points before starting to code:

• Provide the comment ID and authentication for its site. Each request checks access to the current comment, including requests for subsequent pages. A denied or missing comment fails the request.
• History can contain content that differs from the current comment. Updates are asynchronous, so a recent edit might not appear immediately.
• Deleting a comment triggers deletion of its history. Don't use this API as a permanent audit archive or draft store.

Pagination and sorting

List Comment Content Revisions defaults to 20 entries, sorted by history record creation time ascending. createdDate is the supported sorting field. Use the cursor in pagingMetadata.cursors.next to load subsequent pages. Omit sort on subsequent pages: the cursor retains the original ordering, but a supplied unsupported sort field still fails validation.

The returned createdDate uses the saved content's date when available, falling back to the history record's creation date. It is not necessarily the time the history service stored the entry.

Use cases

• Display a comment's edit history.
• Refresh history after an edit.

See also

• List Comment Content Revisions.