Run History

This instance’s own past — what was changed on this branch since it was forked.

GET/api/v1/runs/{run_id}/history

Authorization

AuthorizationBearer token · headerrequired

AuthorizationOAuth2 access token · headerrequired

Path parameters

run_idstringrequired

Query parameters

windowinteger

Seconds of quiet that separate one entry from the next. A board autosaves the moment you stop typing, so the default folds a working session into one entry; 0 shows every save.

min 0 · max 86400 · default: 300

Responses

200Successful Response

successboolean

default: true

dataHistoryList | any

Show properties

Any of:

HistoryList

checkpointsCheckpoint[]required

Show properties

Array of Checkpoint

atstring<date-time>required

actor_idstring | any

Show properties

Any of:

string

string

any

any

changedstring[]required

savesintegerrequired

createdboolean

default: false

authorsobject

restorableboolean

default: true

any

any

messagestring | any

Show properties

Any of:

string

string

any

any

errorsstring[] | any

Show properties

Any of:

string[]

Array of string

string

any

any

422Validation Error

detailValidationError[]

Show properties

Array of ValidationError

locstring | integer[]required

Show properties

Array of string | integer

Any of:

string

string

integer

integer

msgstringrequired

typestringrequired

inputany

ctxobject

Request

curl -X GET "/api/v1/runs/string/history" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("/api/v1/runs/string/history", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.get(
    "/api/v1/runs/string/history",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

{
  "success": true,
  "data": {
    "checkpoints": [
      {
        "at": "2019-08-24T14:15:22Z",
        "actor_id": "string",
        "changed": [
          "string"
        ],
        "saves": 0,
        "created": false
      }
    ],
    "authors": {
      "property1": "string",
      "property2": "string"
    },
    "restorable": true
  },
  "message": "string",
  "errors": [
    "string"
  ]
}