Create Dashboard
DescriptionYou can create a private dashboard and add one or more widgets to it. Each widget is based on a query or one or more alerts
Request
URLURL
Request Body
{
"dashboardType": "USER_DEFINED",
"name": "string",
"widgets": [
{
"name": "string",
"queryDefinitionLink": "string",
"widgetPlacement": {
"height": 4,
"width": 4,
"x": 0,
"y": 0
},
"widgetType": "CHART"
}
]
}
All allowed dashboard types, which include: USER_DEFINED
Possible values are: USER_DEFINED
A unique name for each dashboard
A unique identifier for each dashboard
Unique ID associated with the org
Email of the user who created this dashboard
List of tags associated with this dashboard
ISO8601 date string that informs when this dashboard was created
Represents whether this dashboard is a user’s favorite
ISO8601 date string that informs when this dashboard was updated
Email of the user who last updated this dashboard
ID of the content pack that this dashboard belongs to if the dashboard is part of a content pack
Name of the owner of this dashboard
All allowed feature actions, which include: READ, UPDATE, LOCK, HIDDEN, DISABLED, NONE
Possible values are: READ , UPDATE , LOCK , HIDDEN , DISABLED , NONE
Authentication
Response
Response BodyResponse Body
201 Created
{
"allowedAction": "READ",
"contentPackId": "string",
"createdAt": "string",
"createdBy": "string",
"cspOrgId": "string",
"dashboardType": "USER_DEFINED",
"entityTagAssociation": [
{
"tagId": "string",
"tagName": "string"
}
],
"id": "string",
"isFavourite": false,
"lastUpdatedAt": "string",
"lastUpdatedBy": "string",
"name": "string",
"owner": "string",
"widgets": [
{
"analysisFunctions": [
{
"name": "INFLECTION",
"parameters": {
"key": "string"
}
}
],
"chartOptions": {
"key": "string"
},
"chartType": "string",
"description": "string",
"filter": {
"options": {
"key": "string"
},
"type": "DATE"
},
"name": "string",
"queryDefinitionLink": "string",
"queryDefinitionState": {
"aggregationFunctions": [
{
"fieldName": "string",
"functionName": "COUNT"
}
],
"annotation": false,
"constraints": {
"constraints": [
{
"fieldName": "text",
"operator": "CONTAINS",
"value": "error"
}
],
"fieldName": "string",
"operator": "AND",
"tags": [
"string"
],
"value": "string"
},
"contentPackId": "string",
"createdAt": "string",
"createdBy": "string",
"description": "string",
"documentAuthPrincipalLink": "string",
"documentDescription": {
"description": "string",
"documentIndexingOptions": [
"INDEX_METADATA"
],
"name": "string",
"propertyDescriptions": {
"key": {
"elementDescription": "PropertyDescription Object",
"enumValues": [
"string"
],
"exampleValue": {},
"indexingOptions": [
"EXPAND"
],
"kind": "string",
"propertyDocumentation": "string",
"typeName": "LONG",
"usageOptions": [
"SINGLE_ASSIGNMENT"
]
}
},
"serializedStateSizeLimit": 0,
"serviceCapabilities": [
"INSTRUMENTATION"
],
"serviceRequestRoutes": {
"key": {
"action": "GET",
"description": "string",
"handler": {},
"matcher": {},
"parameters": [
{
"description": "string",
"name": "string",
"paramDef": "QUERY",
"required": false,
"type": "string",
"value": "string"
}
],
"path": "string",
"supportLevel": "NOT_SUPPORTED"
}
},
"userInterfaceResourcePath": "string",
"versionRetentionFloor": 0,
"versionRetentionLimit": 0
},
"documentEpoch": 0,
"documentExpirationTimeMicros": 0,
"documentKind": "string",
"documentOwner": "string",
"documentSelfLink": "string",
"documentSourceLink": "string",
"documentTransactionId": "string",
"documentUpdateAction": "string",
"documentUpdateTimeMicros": 0,
"documentVersion": 0,
"groupByTerms": [
{
"fieldName": "string",
"groupByType": "EACH_VALUE"
}
],
"isAnnotation": false,
"isSearchable": false,
"lastUpdatedAt": "string",
"lastUpdatedBy": "string",
"name": "string",
"relationFunctions": [
{
"relationName": "string",
"relationType": "LOGS",
"shardInfo": {
"key": "string"
}
}
],
"searchable": false,
"source": "USER_DEFINED",
"sourceName": "string",
"tenantLinks": [
"string"
],
"url": "string",
"widget": {
"analysisFunctions": [
{
"name": "INFLECTION",
"parameters": {
"key": "string"
}
}
],
"visualization": {
"options": {
"key": "string"
},
"type": "AREA"
},
"widgetType": "CHART"
}
},
"visualization": {
"options": {
"key": "string"
},
"type": "AREA"
},
"widgetPlacement": {
"height": 4,
"width": 4,
"x": 0,
"y": 0
},
"widgetProperties": {
"key": {}
},
"widgetType": "CHART"
}
]
}
All allowed dashboard types, which include: USER_DEFINED
Possible values are: USER_DEFINED
A unique name for each dashboard
A unique identifier for each dashboard
Unique ID associated with the org
Email of the user who created this dashboard
List of tags associated with this dashboard
ISO8601 date string that informs when this dashboard was created
Represents whether this dashboard is a user’s favorite
ISO8601 date string that informs when this dashboard was updated
Email of the user who last updated this dashboard
ID of the content pack that this dashboard belongs to if the dashboard is part of a content pack
Name of the owner of this dashboard
All allowed feature actions, which include: READ, UPDATE, LOCK, HIDDEN, DISABLED, NONE
Possible values are: READ , UPDATE , LOCK , HIDDEN , DISABLED , NONE
