List dashboards

Returns a list of all dashboards for your account.

Query Parameters
customerId string
isCustomer boolean
Header Parameters
PubNub-Version string — REQUIRED

Possible values: [2026-02-09]

Responses
200
Schema — OPTIONAL
object[]
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.

* required
PubNub-Version*
Type: string
Possible values: [2026-02-09]
customerId
Type: string
isCustomer
Type: boolean