Update Agent Dashboard

Request · cURL

curl -X PUT https://api.{cluster}.{platform}.voiger.io/v1/agent/dashboards/{id} \
  -H "Cookie: sid=$VOIGER_SESSION" \
  -H "x-workspace-code: your-workspace-code" \
  -H "x-csrf-token: $CSRF_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
       "dashboard": {
         "name": "My Custom Dashboard",
         "description": "Personalized dashboard for agent",
         "image_id": "b9788d2e-ca37-41e3-b440-85ae6f8cd4c7",
         "widgets": [
           {
             "category": "analytics",
             "key": "analytics/live_queues",
             "sub_category": "live",
             "settings": {
               "position": 1,
               "size": "medium"
             }
           },
           {
             "category": "analytics",
             "key": "analytics/call_stats",
             "sub_category": "summary",
             "settings": {
               "position": 2,
               "size": "large"
             }
           }
         ]
       }
     }'

const res = await fetch("https://api.{cluster}.{platform}.voiger.io/v1/agent/dashboards/{id}", {
  method: "PUT",
  credentials: "include",
  headers: { "x-workspace-code": "your-workspace-code" },
  headers: { "Content-Type": "application/json", "x-csrf-token": csrf },
  body: JSON.stringify({
    "dashboard": {
      "name": "My Custom Dashboard",
      "description": "Personalized dashboard for agent",
      "image_id": "b9788d2e-ca37-41e3-b440-85ae6f8cd4c7",
      "widgets": [
        {
          "category": "analytics",
          "key": "analytics/live_queues",
          "sub_category": "live",
          "settings": {
            "position": 1,
            "size": "medium"
          }
        },
        {
          "category": "analytics",
          "key": "analytics/call_stats",
          "sub_category": "summary",
          "settings": {
            "position": 2,
            "size": "large"
          }
        }
      ]
    }
  }),
})

const data = await res.json()

Parameters

x-workspace-code string required in header

x-csrf-token string required in header

id string required in path

Dashboard ID

Response

dashboard▾

object

id

string Dashboard unique identifier

name

string Dashboard name

description

string Dashboard description

image_id

string Dashboard image identifier (can be null)

visibility

string Dashboard visibility setting

mutable

boolean Whether the dashboard can be modified

is_primary

boolean Whether this is the primary dashboard

owner_id

string Dashboard owner agent ID

created_at

string Creation timestamp

updated_at

string Last update timestamp

widgets▾

array List of widgets in the dashboard

id

string Widget unique identifier

key

string Widget key identifier

category

string Widget category

sub_category

string Widget sub-category

settings

object Widget configuration settings

created_at

string Creation timestamp

updated_at

string Last update timestamp