Dashboards API
Dashboards are collections of graphs that belong to projects.
Note: Dashboards used to be called Groups. This endpoint still supports that terminology, but it is deprecated and will not be supported in the next version of the API.
list
GET /api/2/organizations/:organization_id/projects/:project_id/dashboards
Example Response
HTTP Status: 200 OK
[ { "id": 2, "name": "Customer Specific", "project_id": 2, "position": 0, "created_at": "2016-01-29T22:15:32.244Z", "updated_at": "2016-01-29T22:15:32.244Z" }, { "id": 1, "name": "Deploy", "project_id": 2, "position": 0, "created_at": "2016-01-29T22:15:12.122Z", "updated_at": "2016-01-29T22:15:12.122Z" } ]
show
GET /api/2/organizations/:organization_id/projects/:project_id/dashboards/:dashboard_id
Example Response
HTTP Status: 200 OK
{ "id": 2, "name": "Customer Specific", "project_id": 2, "position": 0, "created_at": "2016-01-29T22:15:32.244Z", "updated_at": "2016-01-29T22:15:32.244Z" }
create
POST /api/2/organizations/:organization_id/projects/:project_id/dashboards
Required Parameters
name
string, limit 255 characters
Example Request Body
{ "name": "Database" }
Example Response
HTTP Status: 201 CREATED
{ "id": 3, "name": "Database", "project_id": 2, "position": 0, "created_at": "2016-01-29T22:19:41.005Z", "updated_at": "2016-01-29T22:19:41.005Z" }
update
PATCH /api/2/organizations/:organization_id/projects/:project_id/dashboards/:dashboard_id
Example Request Body
{ "name": "Deep Database" }
Example Response
HTTP Status: 204 NO CONTENT
{ "id": 3, "name": "Database", "project_id": 2, "position": 0, "created_at": "2016-01-29T22:19:41.005Z", "updated_at": "2016-01-29T24:22:01.398Z" }
destroy
DELETE /api/2/organizations/:organization_id/projects/:project_id/dashboards/:dashboard_id
Example Response
HTTP Status: 200 OK