Skip to main content
PUT
/
analytics
/
widgets
/
{widgetId}
Update widget
curl --request PUT \
  --url https://app2.freyavoice.ai/api/v2/analytics/widgets/{widgetId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "structuredDataId": 123,
  "chartType": "line",
  "columnWidth": "1/4",
  "rowIndex": 1,
  "sortOrder": 1,
  "config": {
    "colors": [
      "<string>"
    ],
    "colorTheme": "purple",
    "aggregation": "sum",
    "showLegend": true,
    "dateRangeOverride": {
      "from": "<string>",
      "to": "<string>"
    },
    "defaultDateRangePreset": "today",
    "multiFieldIds": [
      123
    ],
    "fieldSelectionMode": "single",
    "topN": 123,
    "agentIds": [
      "<string>"
    ]
  }
}
'
{
  "success": true,
  "data": {
    "message": "<string>",
    "result": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "description": "<string>",
      "structuredDataId": 123,
      "chartType": "<string>",
      "columnWidth": "<string>",
      "rowIndex": 123,
      "sortOrder": 123,
      "config": {},
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

widgetId
string<uuid>
required

Body

application/json
name
string
Maximum string length: 100
description
string | null
Maximum string length: 500
structuredDataId
integer | null
chartType
enum<string>
Available options:
line,
area,
radar,
pie,
donut,
treemap,
stacked_bar,
stream
columnWidth
enum<string>
Available options:
1/4,
1/3,
1/2,
2/3,
3/4,
full
rowIndex
integer
Required range: x >= 0
sortOrder
integer
Required range: x >= 0
config
object

Response

Updated widget

success
enum<boolean>
required
Available options:
true,
false
data
object
required