DocsAPI ReferencePost/api/v1/post/history/diff
getPostPublic API v1

/api/v1/post/history/diff

Returns a structured diff between two revisions of the same post and locale.

Title is word-grain (titles are short, word grain reads naturally), content is line-grain (HTML/markdown bodies — line grain keeps block edits readable). Each diff segment is tagged add / remove / context; concatenating context+add produces the to document, concatenating context+remove produces the from document.

Both revisions must belong to the same post and same locale; cross-post or cross-locale diffs return an error envelope.

postgetApiV1PostHistoryDiff

Parameters

3 query

3 total
Query · 3
apiKeystringRequired

Your BizKitHub API key (passed as GET parameter).

Key format: A 32-character string matching: ^(PROD|DEV_|ROOT)[A-Za-z0-9]{28}$
Prefixes: PROD (production key), DEV_ (individual developer), ROOT (system key with no limits). Learn more

fromstringRequired

Older revision handle (left side of the diff).

tostringRequired

Newer revision handle (right side of the diff).

Request

GET /api/v1/post/history/diff

get
curl -X GET "https://api.bizkithub.com/api/v1/post/history/diff?apiKey=PRODPGrFxpGEtrOZfuWhnoJohUYBXuOE&from=vErSiOnHaNdLe123&to=vErSiOnHaNdLe456" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

JSON payload

{
  "from": {
    "id": "example_id",
    "title": "example_title",
    "contentSize": 0,
    "locale": "example_locale",
    "author": {
      "name": "example_name"
    }
  },
  "to": {
    "id": "example_id",
    "title": "example_title",
    "contentSize": 0,
    "locale": "example_locale",
    "author": {
      "name": "example_name"
    }
  },
  "titleDiff": [
    {
      "value": "example_value"
    }
  ],
  "contentDiff": [
    {
      "value": "example_value"
    }
  ],
  "stats": {
    "titleAdded": 0,
    "titleRemoved": 0,
    "contentAddedLines": 0,
    "contentRemovedLines": 0
  }
}

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key