Dashboard Versions

    • limit - Maximum number of results to return
    • start - Version to start from when returning queries

    Gets all existing dashboard versions for the dashboard with the given dashboardId.

    Example request for getting all dashboard versions:

    Example Response

    1. HTTP/1.1 200 OK
    2. Content-Type: application/json; charset=UTF-8
    3. Content-Length: 428
    5. [
    6.   {
    7.     "id": 2,
    8.     "dashboardId": 1,
    9.     "parentVersion": 1,
    10.     "restoredFrom": 0,
    11.     "version": 2,
    12.     "created": "2017-06-08T17:24:33-04:00",
    13.     "createdBy": "admin",
    14.     "message": "Updated panel title"
    15.   },
    16.   {
    17.     "id": 1,
    18.     "dashboardId": 1,
    19.     "parentVersion": 0,
    20.     "restoredFrom": 0,
    21.     "version": 1,
    22.     "created": "2017-06-08T17:23:33-04:00",
    24.     "message": "Initial save"
    25.   }
    26. ]

    Status Codes:

    • 200 - Ok
    • 401 - Unauthorized
    • 404 - Dashboard version not found

    GET /api/dashboards/id/:dashboardId/versions/:id

    Get the dashboard version with the given id, for the dashboard with the given id.

    Example request for getting a dashboard version:

    1. GET /api/dashboards/id/1/versions/1 HTTP/1.1
    2. Accept: application/json
    3. Content-Type: application/json
    4. Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

    Status Codes:

    • 200 - Ok
    • 401 - Unauthorized
    • 404 - Dashboard version not found

    POST /api/dashboards/id/:dashboardId/restore

    Restores a dashboard to a given dashboard version.

    Example request for restoring a dashboard version:

    1. POST /api/dashboards/id/1/restore
    2. Accept: application/json
    3. Content-Type: application/json
    4. Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
    6. {
    7.   "version": 1
    8. }

    JSON body schema:

    • version - The dashboard version to restore toExample response:
    1. HTTP/1.1 200 OK
    2. Content-Type: application/json; charset=UTF-8
    3. Content-Length: 67
    5. {
    6.   "slug": "my-dashboard",
    8.   "version": 3
    9. }

    JSON response body schema:

    • slug - the URL friendly slug of the dashboard’s title
    • status - whether the restoration was successful or not

    • version - the new dashboard version, following the restorationStatus codes:

    • 401 - Unauthorized
    • 404 - Not found (dashboard not found or dashboard version not found)

    JSON response body schema:

    • message - Message explaining the reason for the request failure.

    POST /api/dashboards/calculate-diff

    Compares two dashboard versions by calculating the JSON diff of them.

    Example request:

    1. POST /api/dashboards/calculate-diff HTTP/1.1
    2. Accept: text/html
    3. Content-Type: application/json
    4. Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
    6. {
    7.   "base": {
    8.     "dashboardId": 1,
    9.     "version": 1
    10.   },
    11.   "new": {
    12.     "dashboardId": 1,
    13.     "version": 2
    14.   },
    15.   "diffType": "json"
    16. }

    JSON body schema:

    • base - an object representing the base dashboard version
    • new - an object representing the new dashboard version
    • diffType - the type of diff to return. Can be “json” or “basic”.Example response (JSON diff):
    1. HTTP/1.1 200 OK
    2. Content-Type: text/html; charset=UTF-8
    4. <p id="l1" class="diff-line diff-json-same">
    6. </p>

    The response is a textual representation of the diff, with the dashboard values being in JSON, similar to the diffs seen on sites like GitHub or GitLab.

    Status Codes:

    • 200 - Ok
    • 400 - Bad request (invalid JSON sent)
    • 401 - Unauthorized
    • 404 - Not foundExample response (basic diff):

    Status Codes:

    • 200 - OK
    • 400 - Bad request (invalid JSON sent)
    • 401 - Unauthorized