ダッシュボード

ダッシュボードの作成

ダッシュボードを作成します。

POST /api/v0/dashboards

すでに使われているurlPathを指定して新たにダッシュボードを作ることはできません。

APIキーに必要な権限

  • Read
  • Write

入力

以下のキーをもつオブジェクト。

KEY TYPE DESCRIPTION
title string ダッシュボード名。
bodyMarkdown string Markdown形式で書かれたダッシュボード詳細。
urlPath string ダッシュボードのURLパス。 *1

*1 urlPathのフォーマットは以下の通りです:

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

応答

成功時

作成されたダッシュボードを返します。

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

<dashboardId> : このダッシュボードに割り当てられた ID です。以降のリクエストではこの ID を用いてダッシュボードを識別します。

失敗時

STATUS CODE DESCRIPTION
400 入力が受け付けられないフォーマットだったとき
403 作成できるダッシュボード数の上限に達してるとき、もしくはリードオンリーなAPIキーを利用してるとき
409 すでに存在してるURLを指定してしまったとき

ダッシュボードの取得

GET /api/v0/dashboards/<dashboardId>

APIキーに必要な権限

  • Read

応答

成功時

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

失敗時

STATUS CODE DESCRIPTION
400 入力が受け付けられないフォーマットだったとき
404 指定されたIDのダッシュボードがみつからないとき

ダッシュボードの更新

PUT /api/v0/dashboards/<dashboardId>

APIキーに必要な権限

  • Read
  • Write

入力

ダッシュボードの作成と同様です。

応答

成功時

更新後のダッシュボードを返します。ダッシュボードの作成 と同様の形式です。

失敗時

STATUS CODE DESCRIPTION
400 入力が受け付けられないフォーマットだったとき
403 リードオンリーなAPIキーを利用してるとき
404 指定されたIDのダッシュボードがみつからないとき
409 すでに存在しているURLを指定してしまったとき *1

*1 ダッシュボードのURLも更新したい場合、既存のダッシュボードのURLと重複する可能性があるのでその際409が返されます。


ダッシュボードの削除

指定されたIDのダッシュボードを削除します。

DELETE /api/v0/dashboards/<dashboardId>

APIキーに必要な権限

  • Read
  • Write

応答

成功時

削除前のダッシュボードを返します。ダッシュボードの作成 と同様です。

失敗時

STATUS CODE DESCRIPTION
403 リードオンリーなAPIキーを利用してるとき
404 指定されたIDのダッシュボードがみつからないとき

ダッシュボードの一覧

GET /api/v0/dashboards

APIキーに必要な権限

  • Read

応答

{
  "dashboards": [ <dashboard>, <dashboard>, …]
}

<dashboard>ダッシュボードの作成 で返ってくるオブジェクトと同型です。