4.5 KiB
Dashboard API
TL; DR
Here are the objects we are thinking about; dashboards contain layouts which contain explorations.
Dashboard
{
"links": {
"self": "/chronograf/v1/dashboards/myid"
},
"id": "myid",
"queries": [
{
"x": 0,
"y": 0,
"w": 2,
"h": 1,
"label": "Objects/Second",
"range": {
"upper": 100,
"lower": 10
},
"link": "/chronograf/v1/queries/1"
},
{
"x": 2,
"y": 0,
"w": 2,
"h": 1,
"label": "Widgets/Second",
"range": {
"upper": 10,
"lower": 0
},
"link": "/chronograf/v1/queries/2"
}
],
"name": "This is my dashboard",
}
Query
{
"query": "SELECT mean(n_cpu) from cpu GROUP BY time(15m)",
"db": "telegraf",
"rp": "",
"links" : {
"self": "/chronograf/v1/queries/1"
}
}
API
/dashboards
GET /dashboards
Returns a list of dashboards
{
"dashboards": [
{
"links": {
"self": "/chronograf/v1/dashboards/myid"
},
"id": "myid",
"queries": [
{
"x": 0,
"y": 0,
"w": 2,
"h": 1,
"label": "Objects/Second",
"range": {
"upper": 100,
"lower": 10
},
"link": "/chronograf/v1/queries/1"
},
{
"x": 2,
"y": 0,
"w": 2,
"h": 1,
"label": "Widgets/Second",
"range": {
"upper": 10,
"lower": 0
},
"link": "/chronograf/v1/queries/2"
}
],
"name": "This is my dashboard"
},
{
"links": {
"self": "/chronograf/v1/dashboards/myid"
},
"id": "myid",
"queries": [
{
"x": 0,
"y": 0,
"w": 2,
"h": 1,
"label": "Objects/Second",
"range": {
"upper": 100,
"lower": 10
},
"link": "/chronograf/v1/queries/1"
},
{
"x": 2,
"y": 0,
"w": 2,
"h": 1,
"label": "Widgets/Second",
"range": {
"upper": 10,
"lower": 0
},
"link": "/chronograf/v1/queries/2"
}
],
"name": "This is my dashboard"
}
]
}
GET /dashboards/myid
Returns an single dashboard object
{
"links": {
"self": "/chronograf/v1/dashboards/myid"
},
"id": "myid",
"queries": [
{
"x": 0,
"y": 0,
"w": 2,
"h": 1,
"label": "Objects/Second",
"range": {
"upper": 100,
"lower": 10
},
"link": "/chronograf/v1/queries/1"
},
{
"x": 2,
"y": 0,
"w": 2,
"h": 1,
"label": "Widgets/Second",
"range": {
"upper": 10,
"lower": 0
},
"link": "/chronograf/v1/queries/2"
}
],
"name": "This is my dashboard"
}
PUT /dashboards/myid
We want complete updates to the dashboards because we don't know if we can actually incrementally update visualization metadata
This endpoint will respond with the dashboard after update.
DELETE
Removes a dashboard but will not remove the queries. This will lead to orphans.
Should we have a page that lists all the queries?
POST
Creating a dashboard from an exploration would need to be a two-step process
- Create a query
- Create dashboard including query link
/queries
The queries endpoint will be a simple CRUD endpoint storing the raw query:
{
"query": "SELECT mean(n_cpu) from cpu GROUP BY time(15m)",
"db": "telegraf",
"rp": "",
"links" : {
"self": "/chronograf/v1/queries/1"
}
}
Over time I'd like this queries endpoint to support a format parameter to return
the query data in different JSON formats such as QueryConfig.