Skip to main content
GET
Compare two commits

Authorizations

Authorization
string
header
required

A Nemonist key (sk-nm-...) as a bearer token in the Authorization header.

Path Parameters

id
string
required

The folder's id (fld_...), as GET /folders lists it.

basehead
string
required
... or .. (URL-encoded); head may be empty, or HEAD alone, for today. Each end may be HEAD~N or ~N (N commits older; HEAD~0 is the newest commit itself).

Response

The comparison.

A comparison of two commits.

base_commit
object
required

One end of a comparison: a commit, or today.

head_commit
object
required

One end of a comparison: a commit, or today.

status
string
required

ahead, behind or identical.

ahead_by
integer
required

Commits in head that base lacks.

behind_by
integer
required

Commits in base that head lacks.

total_commits
integer
required

Commits in the range (ahead_by).

commits
object[]
required

The range's commits, oldest first.

files
object[]
required

The notes that differ, by path.

merge_base_commit
object

One end of a comparison: a commit, or today.

truncated
object

Whether a list was cut at its cap.

html_url
string

The folder's range compare page on the dashboard (compare= on its Commits tab): base and head pickers, the summary, the commits oldest first and each changed note's diff, as GitHub's compare page.