PATCH
/
dashboard
/
widgets
/
{id}
Update a dashboard widget
curl --request PATCH \
  --url https://core.ravenna.ai/api/dashboard/widgets/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-ravenna-api-token: <api-key>' \
  --data '{
  "type": "TREND",
  "name": "<string>",
  "description": "<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"
  }
}'
{
  "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"
  }
}

Authorizations

x-ravenna-api-token
string
header
required

Path Parameters

id
string
required

Body

application/json
type
enum<string>
Available options:
TREND,
METRIC
name
string
Minimum length: 1
description
string | null
query
object
displayConfig
object

Response

Successful response

id
string
required
slug
string
required
name
string
required
description
string | null
required
dashboardId
string
required
dashboard
object
required
createdAt
string
required
updatedAt
string
required
type
string
required
Allowed value: "TREND"
query
object
required
displayConfig
object