Skip to main content
POST
Create a dashboard

Authorizations

Authorization
string
header
required

API key authentication using Bearer token format: Bearer <basedash_api_key>

Path Parameters

orgId
string
required

Organization ID

Body

application/json
name
string
required

Name of the dashboard

Minimum string length: 1
description
string | null

Optional description of the dashboard

icon
string

Icon name for the dashboard

Minimum string length: 1
color
string

Icon color key for the dashboard

Minimum string length: 1
dashboardFolderId
string | null

ID of the folder to place the dashboard in

width

Width of the dashboard grid

Available options:
NORMAL
defaultDateRange

Default date range applied to the dashboard

Available options:
CUSTOM
defaultCustomDateRangeStart
string<date-time> | null

Start of the custom date range (when defaultDateRange is CUSTOM)

defaultCustomDateRangeEnd
string<date-time> | null

End of the custom date range (when defaultDateRange is CUSTOM)

defaultGroupByInterval

Default group-by interval applied to the dashboard

Available options:
HOUR

Response

Dashboard created successfully

data
object
required