Skip to main content
Version: Next

DashboardCopySchema

cssstring

Override CSS for the dashboard.

dashboard_titlestringnullable

A title for the dashboard.

Possible values: <= 500 characters

duplicate_slicesboolean

Whether or not to also copy all charts on the dashboard

json_metadatastringrequired

This JSON object is generated dynamically when clicking the save or overwrite button in the dashboard view. It is exposed here for reference and for power users who may want to alter specific parameters. When AUTO_REFRESH_POLICY is enabled, the optional auto_refresh_policy key holds the dashboard's auto-refresh policy: auto_refresh_allowed (boolean, default true), minimum_refresh_interval and maximum_refresh_interval (each null or {"value": <whole number >= 1>, "unit": "seconds" | "minutes" | "hours"}; the length must be one of the standard refresh intervals, no other upper limit). With a policy, refresh_frequency must be 0 or a whole number of seconds that is a standard interval within the bounds, and 0 when auto-refresh isn't allowed. On create, a missing or null auto_refresh_policy means no policy. An update or copy that omits auto_refresh_policy keeps the stored policy; send null to remove it.

replace_metadataboolean

Use json_metadata as the complete copy settings instead of merging with the source dashboard's settings. Defaults to false. Chart-specific settings are pruned and remapped in both modes.

Default value: false
DashboardCopySchema
{
"css": "string",
"dashboard_title": "string",
"duplicate_slices": true,
"json_metadata": "string",
"replace_metadata": false
}