Pivot dashboards API
Create, read, or edit your dashboards using the Pivot API.
Get all dashboards or a get single named dashboards
Returns a list of all dashboards, or returns a dashboards with a {name}
that you specify.
URL
GET /api/v1/dashboards/{name}
Success response
Code | Description |
---|---|
200 | OK |
Selected error response
Code | Example body |
---|---|
404 Not Found | ”error": "Not found." |
Sample request
curl --location --request GET 'http://localhost:9095/api/v1/dashboards' \
--header 'x-imply-api-token:<token>'
Response body
[
{
"name": "string",
"title": "string",
"description": "string",
"theme": "string",
"verticalUnits": "string",
"filterToken": "string",
"shareTimezone": true,
"enforceTimeFilter": false,
"hasGlobalCompare": false,
"defaultCompare": false,
"readAccess": {
"users": [
"string"
],
"roles": [
"string"
],
"access": "all"
},
"modifyAccess": {
"users": [
"string"
],
"roles": [
"string"
],
"access": "all"
},
"restrictedEditAccess": {
"users": [
"string"
],
"roles": [
"string"
],
"access": "all"
}
}
]
Create or update a dashboard by name
Creates or updates a dashboard with a {name}
that you specify.
URL
POST /api/v1/dashboards/{name}
Request body
curl -X POST --header "Content-Type:application/json" --header "x-imply-api-token:<token>" --data '
{
"dashboard": {
"name": "string",
"title": "string",
"description": "string",
"theme": "string",
"verticalUnits": "string",
"filterToken": "string",
"shareTimezone": true,
"enforceTimeFilter": false,
"hasGlobalCompare": false,
"defaultCompare": false,
"readAccess": {
"users": [
"string"
],
"roles": [
"string"
],
"access": "all"
},
"modifyAccess": {
"users": [
"string"
],
"roles": [
"string"
],
"access": "all"
},
"restrictedEditAccess": {
"users": [
"string"
],
"roles": [
"string"
],
"access": "all"
}
}
}
Success response
Code | Description |
---|---|
200 | OK |
Selected error response
Code | Example body |
---|---|
404 Not Found | ”error": "Not found." |
Response body
[
{
"name": "string",
"title": "string",
"description": "string",
"theme": "string",
"verticalUnits": "string",
"filterToken": "string",
"shareTimezone": true,
"enforceTimeFilter": false,
"hasGlobalCompare": false,
"defaultCompare": false,
"readAccess": {
"users": [
"string"
],
"roles": [
"string"
],
"access": "all"
},
"modifyAccess": {
"users": [
"string"
],
"roles": [
"string"
],
"access": "all"
},
"restrictedEditAccess": {
"users": [
"string"
],
"roles": [
"string"
],
"access": "all"
}
}
]
Delete a dashboard by name
Deletes a dashboard with a {name}
that you specify.
URL
DELETE /api/v1/dashboards/{name}
Sample request
curl -X DELETE --header "x-imply-api-token:<token>" localhost:9095/api/v1/dashboards/<dashboardName>
Success response
Code | Description |
---|---|
200 | OK |
Selected error response
Code | Example body |
---|---|
404 Not Found | ”error": "Not found." |