Dashboards (Legacy)

This page explains the API for Custom Dashboards (Legacy Custom Dashboards) before the feature's renovation as of November 2018. For details regarding the API operating the new feature following its renovation, refer here.

Creating Dashboards

This section covers creating dashboards.

POST /api/v0/dashboards

It's not possible to specify a URL path that is already being used to create a new dashboard.

Required permissions for API key

  • Read
  • Write

Input

Objects that hold the following keys:

KEY TYPE DESCRIPTION
title string the dashboard's name
bodyMarkdown string the particulars of the dashboard written in Markdown
urlPath string the dashboard's URL path *1

*1 URL path should be as follows:

^([A-Za-z0-9_][-A-Za-z0-9_]*)(/[A-Za-z0-9_][-A-Za-z0-9_]*)*$

Response

Success

The dashboard that was created is returned.

{
  "id": <dashboardId>,
  "title": "My Dashboard",
  "bodyMarkdown": "# A test dashboard",
  "urlPath": "2u4PP3TJqbu",
  "createdAt": 1439346145003,
  "updatedAt": 1439346145003
}

<dashboardId> : This is the ID that was assigned to this dashboard. With future requests, this ID will identify the dashboard.

Error

STATUS CODE DESCRIPTION
400 when the input is in a format that can’t be accepted
403 when you have reached your dashboard limit / when the API doesn't have the required permissions / when accessing from outside the permitted IP address range
409 when you have accidentally specified an already existing URL

Getting Dashboards

GET /api/v0/dashboards/<dashboardId>

Required permissions for API key

  • Read

Response

Success

{
  "id": <dashboardId>,
  "title": "My Dashboard",
  "bodyMarkdown": "# A test dashboard",
  "urlPath": "2u4PP3TJqbu",
  "createdAt": 1439346145003,
  "updatedAt": 1439346145003
}

Error

STATUS CODE DESCRIPTION
400 when the input is in a format that can’t be accepted
404 when the dashboard corresponding to the designated ID can't be found

Updating Dashboards

PUT /api/v0/dashboards/<dashboardId>

Required permissions for API key

  • Read
  • Write

Input

Same as Creating Dashboards.

Response

Success

The updated dashboard is returned. Same format as Creating Dashboards.

Error

STATUS CODE DESCRIPTION
400 when the input is in a format that can’t be accepted
403 when the API doesn't have the required permissions / when accessing from outside the permitted IP address range
404 when the dashboard corresponding to the designated ID can't be found
409 when you have accidentally specified an already existing URL *1

*1 When you want to update a dashboard's URL, there is a possibility of redundancy with the URL of another existing dashboard. If that happens a 409 error code will be returned.


Deleting Dashboards

This will delete the dashboard corresponding to the designated ID.

DELETE /api/v0/dashboards/<dashboardId>

Required permissions for API key

  • Read
  • Write

Response

Success

The dashboard before deletion is returned, same as Creating Dashboards.

Error

STATUS CODE DESCRIPTION
403 when the API doesn't have the required permissions / when accessing from outside the permitted IP address range
404 when the dashboard corresponding to the designated ID can't be found