Skip to main content
PATCH
Update a dashboard

Authorizations

X-CEKURA-API-KEY
string
header
required

API Key Authentication. It should be included in the header of each request.

Path Parameters

id
string
required

Body

name
string | null

Name of the dashboard

Maximum string length: 255
project
integer | null

Project this dashboard belongs to

source
enum<string>

Dataset the widgets plot: call_logs (production calls, the default) or runs (simulation test runs). Set on create; it cannot be changed afterwards.

  • call_logs - Call Logs
  • runs - Runs
Available options:
call_logs,
runs
filters
object | null

Filter conditions to scope the data. See the Dashboards guide for supported fields, operators, and syntax.

Examples:

Response

200 - application/json
id
integer
read-only
name
string | null

Name of the dashboard

Maximum string length: 255
project
integer | null

Project this dashboard belongs to

source
enum<string>

Dataset the widgets plot: call_logs (production calls, the default) or runs (simulation test runs). Set on create; it cannot be changed afterwards.

  • call_logs - Call Logs
  • runs - Runs
Available options:
call_logs,
runs
is_default
boolean
read-only

Whether this is the project's default dashboard for its source.

filters
object | null

Filter conditions to scope the data. See the Dashboards guide for supported fields, operators, and syntax.

Examples:
widgets
object[]
read-only
widget_count
string
read-only

Number of widgets in the dashboard

created_at
string<date-time> | null
read-only

When the dashboard was created

updated_at
string<date-time> | null
read-only

When the dashboard was last updated