Public Dashboards

Create a public link for a dashboard

post/api/{org_id}/dashboards/{dashboard_id}/public_links

Request

Path parameters

org_idstring required

Organization name

dashboard_idstring required

Dashboard id

Request body

expires_atinteger nullable
frozen_variablesobject
namestring

Label that tells a dashboard's links apart; empty is allowed.

refresh_secsinteger
visibility'draft' | 'public'

Draft configures the share without exposing it; Public serves it and is the default.

Response

Success

access_countinteger required
created_atinteger required
dashboard_idstring required
dashboard_titlestring nullable
enabledboolean required
expires_atinteger nullable
folder_idstring nullable
folder_namestring nullable
frozen_variablesobject required
idstring required
last_accessed_atinteger nullable
namestring required
published_bystring required
publisher_leftboolean required

The publisher is no longer an org member; the link may still be enabled while cleanup lags.

refresh_secsinteger required
slugstring nullable

Null when the caller cannot read the link's dashboard.

status'live' | 'paused' | 'not_viewed' | 'needs_attention' | 'expired' | 'dashboard_deleted' | 'disabled' required

A link's state as the admin UI shows it; NeedsAttention comes from the batch status call.

updated_atinteger required
updated_bystring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.