Docs API Reference Post/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

Query parameters

· 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

ExamplePRODPGrFxpGEtrOZfuWhnoJohUYBXuOE

fromstringRequired

Older revision handle (left side of the diff).

ExamplevErSiOnHaNdLe123

tostringRequired

Newer revision handle (right side of the diff).

ExamplevErSiOnHaNdLe456

Response schema

1 status code documented

200Success

object | object

One of 2:

Variant 1

fromobjectRequired

idstringRequired

insertedDateDate | string | string | numberRequired

One of 4:

Variant 1

Date

Variant 2

stringdate-time

Variant 3

stringdate

Variant 4

number

titlestringRequired

contentSizenumberRequired

localestringRequired

authorobjectRequired

idstring | nullRequired

One of 2:

Variant 1

string

Variant 2

null

namestringRequired

toobjectRequired

idstringRequired

insertedDateDate | string | string | numberRequired

One of 4:

Variant 1

Date

Variant 2

stringdate-time

Variant 3

stringdate

Variant 4

number

titlestringRequired

contentSizenumberRequired

localestringRequired

authorobjectRequired

idstring | nullRequired

One of 2:

Variant 1

string

Variant 2

null

namestringRequired

titleDiffobject[]Required

Each array item:

type"context" | "add" | "remove"Required

valuestringRequired

contentDiffobject[]Required

Each array item:

type"context" | "add" | "remove"Required

valuestringRequired

statsobjectRequired

titleAddednumberRequired

titleRemovednumberRequired

contentAddedLinesnumberRequired

contentRemovedLinesnumberRequired

Variant 2

state"error"Required

messagestringRequired

code"200"Required

hintstring | nullRequired

One of 2:

Variant 1

string

Variant 2

null

Response example

application/json

{
  "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
  }
}

Request example

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"

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key