Dashboards
Dashboards are used in projects to visualize the project data.
Methods
List Dashboards
GET https://squirro-endpoint/api/topic/v0/(string: tenant)/projects/(id: project_id)/dashboards
Returns an array of all dashboards in a project.
Parameters: |
|
---|---|
Headers: | See Common Headers. |
Status Codes: |
See also Common Status Codes. |
Returns: | Array of dashboards. [{ "search": { "query": "Squirro" }, "title": "Squirro", "widgets": [{ "title": "Results", "col": 1, "row": 1, "size_x": 8, "size_y": 6, "type": "Search", "id": 1 }], "type": "result", "id": "PSUHQNx8Tie81tfN5d1Nxg", "column_count": 16, "row_height": 55 }] |
Create Dashboard
POST
https://squirro-endpoint/api/topic
/v0/(string: tenant)/projects/(id: project_id)/dashboards
Parameters: |
|
---|---|
JSON Data: | Data is passed in as a JSON object. Valid object keys:
|
Headers: | See Common Headers. |
Status Codes: |
See also Common Status Codes. |
Returns: | Created dashboard { "search": { "query": "Squirro" }, "title": "Squirro", "widgets": [{ "title": "Results", "col": 1, "row": 1, "size_x": 8, "size_y": 6, "type": "Search", "id": 1 }], "type": "result", "id": "PSUHQNx8Tie81tfN5d1Nxg", "column_count": 16, "row_height": 55 } |
Get Dashboard
GET
v0/(string: tenant)/projects/(id: project_id)/dashboards/(id: dashboard_id)https://squirro-endpoint/api/topic
/
Parameters: |
|
---|---|
Headers: | See Common Headers. |
Status Codes: |
See also Common Status Codes. |
Returns: | Dashboard { "search": { "query": "Squirro" }, "title": "Squirro", "widgets": [{ "title": "Results", "col": 1, "row": 1, "size_x": 8, "size_y": 6, "type": "Search", "id": 1 }], "type": "result", "id": "PSUHQNx8Tie81tfN5d1Nxg", "column_count": 16, "row_height": 55 } |
Update Dashboard
PUT https://squirro-endpoint/api/topic/v0/(string: tenant)/projects/(id: project_id)/dashboards/(id: dashboard_id)
Parameters: |
|
---|---|
JSON Data: | Data is passed in as a JSON object. Takes the same input as the Create Dashboard resource. |
Headers: | See Common Headers. |
Status Codes: |
See also Common Status Codes. |
Returns: | Updated dashboard { "search": { "query": "Squirro" }, "title": "Squirro", "widgets": [{ "title": "Results", "col": 1, "row": 1, "size_x": 8, "size_y": 6, "type": "Search", "id": 1 }], "type": "result", "id": "PSUHQNx8Tie81tfN5d1Nxg", "column_count": 16, "row_height": 55 } |
Delete Dashboard
DELETE https://squirro-endpoint/api/topic/v0/(string: tenant)/projects/(id: project_id)/dashboards/(id: dashboard_id)
Parameters: |
|
---|---|
Headers: | See Common Headers. |
Status Codes: |
See also Common Status Codes. |
Move Dashboard
POST https://squirro-endpoint/api/topic/v0/(string: tenant)/projects/(id: project_id)/dashboards/(id: dashboard_id)/move
Moves a dashboard position in the project. This affects the sorting of the dashboard tabs.
Parameters: |
|
---|---|
JSON Data: | Data is passed in as a JSON object with the following key:
|
Headers: | See Common Headers. |
Status Codes: |
See also Common Status Codes.
|