Authorizations
Path Parameters
Body
application/json
Response
Successful response
Available options:
legacy
, v2
, prepackaged
curl --request PATCH \
--url https://core.ravenna.ai/api/dashboards/{id} \
--header 'Content-Type: application/json' \
--header 'x-ravenna-api-token: <api-key>' \
--data '{
"name": "<string>",
"description": "<string>",
"slug": "<string>",
"layout": {
"columns": 12,
"widgets": [
{
"slug": "<string>",
"x": 1,
"y": 1,
"columns": 1,
"rows": 2
}
]
},
"config": {
"filters": [
{
"field": "<string>",
"condition": "<string>",
"value": "<string>",
"given": "<string>"
}
],
"dateFilters": {
"period": "this.day",
"timeInterval": "day",
"dateRange": {
"from": "<string>",
"to": "<string>"
}
}
}
}'
{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"slug": "<string>",
"layout": {
"columns": 12,
"widgets": [
{
"slug": "<string>",
"x": 1,
"y": 1,
"columns": 1,
"rows": 2
}
]
},
"config": {
"filters": [
{
"field": "<string>",
"condition": "<string>",
"value": "<string>",
"given": "<string>"
}
],
"dateFilters": {
"period": "this.day",
"timeInterval": "day",
"dateRange": {
"from": "<string>",
"to": "<string>"
}
}
},
"isSystemCreated": true,
"itemType": "<string>",
"type": "legacy",
"parentId": "<string>",
"organizationId": "<string>",
"organization": {
"id": "<string>",
"name": "<string>"
},
"widgets": [
{
"id": "<string>",
"slug": "<string>",
"name": "<string>",
"description": "<string>",
"dashboardId": "<string>",
"dashboard": {
"id": "<string>",
"name": "<string>"
},
"createdAt": "<string>",
"updatedAt": "<string>",
"type": "<string>",
"query": {
"filterGroups": [
[
{
"field": "<string>",
"condition": "<string>",
"value": "<string>",
"given": "<string>"
}
]
],
"dataSource": "Ticket",
"timeInterval": "day",
"groupBy": [
"<string>"
],
"aggregations": [
{
"type": "count",
"alias": "<string>",
"field": "id"
}
],
"limit": 123,
"sortOrder": "ASC",
"dateField": "<string>"
},
"displayConfig": {
"formatter": "number",
"maximumFractionDigits": 123,
"minimumFractionDigits": 123,
"chartType": "bar",
"orientation": "horizontal"
}
}
],
"createdAt": "<string>",
"updatedAt": "<string>"
}
curl --request PATCH \
--url https://core.ravenna.ai/api/dashboards/{id} \
--header 'Content-Type: application/json' \
--header 'x-ravenna-api-token: <api-key>' \
--data '{
"name": "<string>",
"description": "<string>",
"slug": "<string>",
"layout": {
"columns": 12,
"widgets": [
{
"slug": "<string>",
"x": 1,
"y": 1,
"columns": 1,
"rows": 2
}
]
},
"config": {
"filters": [
{
"field": "<string>",
"condition": "<string>",
"value": "<string>",
"given": "<string>"
}
],
"dateFilters": {
"period": "this.day",
"timeInterval": "day",
"dateRange": {
"from": "<string>",
"to": "<string>"
}
}
}
}'
{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"slug": "<string>",
"layout": {
"columns": 12,
"widgets": [
{
"slug": "<string>",
"x": 1,
"y": 1,
"columns": 1,
"rows": 2
}
]
},
"config": {
"filters": [
{
"field": "<string>",
"condition": "<string>",
"value": "<string>",
"given": "<string>"
}
],
"dateFilters": {
"period": "this.day",
"timeInterval": "day",
"dateRange": {
"from": "<string>",
"to": "<string>"
}
}
},
"isSystemCreated": true,
"itemType": "<string>",
"type": "legacy",
"parentId": "<string>",
"organizationId": "<string>",
"organization": {
"id": "<string>",
"name": "<string>"
},
"widgets": [
{
"id": "<string>",
"slug": "<string>",
"name": "<string>",
"description": "<string>",
"dashboardId": "<string>",
"dashboard": {
"id": "<string>",
"name": "<string>"
},
"createdAt": "<string>",
"updatedAt": "<string>",
"type": "<string>",
"query": {
"filterGroups": [
[
{
"field": "<string>",
"condition": "<string>",
"value": "<string>",
"given": "<string>"
}
]
],
"dataSource": "Ticket",
"timeInterval": "day",
"groupBy": [
"<string>"
],
"aggregations": [
{
"type": "count",
"alias": "<string>",
"field": "id"
}
],
"limit": 123,
"sortOrder": "ASC",
"dateField": "<string>"
},
"displayConfig": {
"formatter": "number",
"maximumFractionDigits": 123,
"minimumFractionDigits": 123,
"chartType": "bar",
"orientation": "horizontal"
}
}
],
"createdAt": "<string>",
"updatedAt": "<string>"
}
Successful response
legacy
, v2
, prepackaged
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Was this page helpful?