Skip to main content
POST
/
analytics
/
widgets
Create widget
curl --request POST \
  --url https://app.freyavoice.ai/api/v2/analytics/widgets \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "description": "<string>",
  "structuredDataId": 123,
  "columnWidth": "1/2",
  "rowIndex": 0,
  "sortOrder": 0,
  "config": {}
}
'
{
  "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.

Body

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

Response

Created widget

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