Update dashboard

Updates an existing dashboard configuration, time ranges, or decision overlays.

Header Parameters
PubNub-Version string — REQUIRED

Possible values: [2026-02-09]

Request Body — REQUIRED
name string — REQUIRED

Possible values: 1 ≤ length ≤ 50

Dashboard title (max 50 characters).

charts object[]

List of charts to display on the dashboard.

name string — REQUIRED

Possible values: 1 ≤ length ≤ 50

Chart name (1-50 characters).

id string

Chart ID. Required for updates.

metric object — REQUIRED

Metric configuration for the chart.

name string — REQUIRED

Possible values: 1 ≤ length ≤ 50

Metric name (1-50 characters).

id string

PubNub-generated unique ID for the metric. Required in later requests to update, delete, or retrieve the metric.

businessObjectId string — REQUIRED

ID of the source business object.

measureId string

Field ID to aggregate (required for AVG, MAX, MIN, SUM functions). References a NUMERIC field from the business object.

evaluationWindow number — REQUIRED

Possible values: 1 ≤ value ≤ 86400

Time period in seconds for metric evaluation. Allowed values: 60 (1 min), 300 (5 min), 600 (10 min), 900 (15 min), 1800 (30 min), 3600 (1 hour), 86400 (1 day).

function string — REQUIRED

Possible values: [AVG, SUM, MAX, MIN, COUNT, COUNT_DISTINCT]

Aggregation function: AVG, COUNT, COUNT_DISTINCT, MAX, MIN, or SUM.

dimensionIds string[]

Field IDs to group by (TEXT fields only). References dimensions from the business object.

filters object[]

Filtering criteria for the metric.

id string

PubNub-generated ID for the metric filter. Required when updating a metric (PUT).

sourceType string — REQUIRED

Possible values: [MEASURE, DIMENSION]

Filter source type. Value must always be DIMENSION.

sourceId string — REQUIRED

ID of the field or data field to filter on.

operation string — REQUIRED

Possible values: [NUMERIC_GREATER_THAN, NUMERIC_GREATER_THAN_EQUALS, NUMERIC_LESS_THAN, NUMERIC_LESS_THAN_EQUALS, NUMERIC_INCLUSIVE_BETWEEN, NUMERIC_EXCLUSIVE_NOT_BETWEEN, BOOLEAN_IS_TRUE, BOOLEAN_IS_FALSE, STRING_CONTAINS, STRING_NOT_CONTAINS, STRING_STARTS_WITH, STRING_ENDS_WITH, STRING_EQUALS, STRING_IS_EMPTY, STRING_IS_NOT_EMPTY, STRING_NOT_EQUALS]

Filter operation: STRING_EQUALS, STRING_NOT_EQUAL, STRING_CONTAINS, STRING_NOT_CONTAINS, STRING_IS_EMPTY, STRING_IS_NOT_EMPTY, STRING_STARTS_WITH, STRING_ENDS_WITH.

arguments string[] — REQUIRED

Filter arguments (1 string). Matching is case-sensitive.

viewType string — REQUIRED

Possible values: [BAR, LINE, STACKED]

Chart visualization type: BAR, LINE, or STACKED.

size string

Possible values: [HALF, FULL]

Chart size: FULL (full width) or HALF (half width).

showDecisions boolean

Whether to display decision overlays on the chart.

dimensionIds string[]

Default selected dimensions for grouping. References field IDs from the business object.

decisionIds string[]

Decision IDs to overlay on the chart.

dateRange string — REQUIRED

Possible values: [30 minutes, 1 hour, 24 hours, 3 days, 1 week, 30 days, 3 months, Custom date]

Date range for dashboard data: 30 minutes, 1 hour, 24 hours, 3 days, 1 week, 30 days, 3 months, or Custom date.

startDate date-time

Custom start date/time (ISO 8601). Required when dateRange is Custom date.

endDate date-time

Custom end date/time (ISO 8601). Required when dateRange is Custom date.

Responses
200
Schema — OPTIONAL
createdAt date-time — OPTIONAL

Creation timestamp (ISO 8601, UTC).

updatedAt date-time — OPTIONAL

Last update timestamp (ISO 8601, UTC).

createdBy string — OPTIONAL

Email of the creator.

updatedBy string — OPTIONAL

Email of the last updater.

id string

PubNub-generated unique ID for the dashboard. Required in later requests to update, delete, or retrieve the dashboard.

name string

Dashboard title (max 50 characters).

accountId string

Your PubNub account ID.

dateRange string

Possible values: [30 minutes, 1 hour, 24 hours, 3 days, 1 week, 30 days, 3 months, Custom date]

Date range for dashboard data: 30 minutes, 1 hour, 24 hours, 3 days, 1 week, 30 days, 3 months, or Custom date.

startDate date-time — OPTIONAL

Custom start date/time (ISO 8601). Required when dateRange is Custom date.

endDate date-time — OPTIONAL

Custom end date/time (ISO 8601). Required when dateRange is Custom date.

charts object[]

List of charts to display on the dashboard.

id string
series object[]
title string
metric string
values object[]
date date-time
value number
tooltip string
customer object — OPTIONAL

Associated OEM customer for this dashboard.

id string

Your unique customer ID for OEM partners (requires Partner Portal).

name string

Customer name.

404
* required
PubNub-Version*
Type: string
Possible values: [2026-02-09]
* required
name*
Type: string
Dashboard title (max 50 characters).
1-50 chars
charts
Type: array
List of charts to display on the dashboard.
Array items:
items
Type: object
dateRange*
Type: string
Date range for dashboard data: 30 minutes, 1 hour, 24 hours, 3 days, 1 week, 30 days, 3 months, or Custom date.
Enum (8 values)
View all values
"30 minutes""1 hour""24 hours""3 days""1 week""30 days""3 months""Custom date"
startDate
Type: string
Custom start date/time (ISO 8601). Required when dateRange is Custom date.
Format: date-time
endDate
Type: string
Custom end date/time (ISO 8601). Required when dateRange is Custom date.
Format: date-time
createdAt
Type: string
Creation timestamp (ISO 8601, UTC).
Format: date-time
updatedAt
Type: string
Last update timestamp (ISO 8601, UTC).
Format: date-time
createdBy
Type: string
nullableEmail of the creator.
updatedBy
Type: string
nullableEmail of the last updater.
id
Type: string
PubNub-generated unique ID for the dashboard. Required in later requests to update, delete, or retrieve the dashboard.
name
Type: string
Dashboard title (max 50 characters).
accountId
Type: string
Your PubNub account ID.
dateRange
Type: string
Date range for dashboard data: 30 minutes, 1 hour, 24 hours, 3 days, 1 week, 30 days, 3 months, or Custom date.
Enum (8 values)
View all values
"30 minutes""1 hour""24 hours""3 days""1 week""30 days""3 months""Custom date"
startDate
Type: string
Custom start date/time (ISO 8601). Required when dateRange is Custom date.
Format: date-time
endDate
Type: string
Custom end date/time (ISO 8601). Required when dateRange is Custom date.
Format: date-time
charts
Type: array
List of charts to display on the dashboard.
Array items:
items
Type: object
customer
Type: object
nullableAssociated OEM customer for this dashboard.