Looker · Schema

WriteDashboard

Writable fields for creating or updating a dashboard

AnalyticsBI PlatformBusiness IntelligenceData AnalyticsData Visualization

Properties

Name Type Description
title string Display title
description string Description of the dashboard
space_id string Space (folder) ID
folder_id string Folder ID
query_timezone string Timezone for queries
background_color string CSS background color
text_tile_text_color string Default text color for text tiles
tile_background_color string Default background color for tiles
tile_text_color string Default text color for tiles
hidden boolean Whether the dashboard is hidden
refresh_interval string Auto-refresh interval
load_configuration string Tile load configuration
preferred_viewer string Preferred viewer type
View JSON Schema on GitHub

JSON Schema

looker-writedashboard-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/WriteDashboard",
  "title": "WriteDashboard",
  "type": "object",
  "description": "Writable fields for creating or updating a dashboard",
  "properties": {
    "title": {
      "type": "string",
      "description": "Display title",
      "example": "Example Title"
    },
    "description": {
      "type": "string",
      "nullable": true,
      "description": "Description of the dashboard",
      "example": "A sample description."
    },
    "space_id": {
      "type": "string",
      "description": "Space (folder) ID",
      "example": "500123"
    },
    "folder_id": {
      "type": "string",
      "description": "Folder ID",
      "example": "500123"
    },
    "query_timezone": {
      "type": "string",
      "description": "Timezone for queries",
      "example": "example_value"
    },
    "background_color": {
      "type": "string",
      "description": "CSS background color",
      "example": "example_value"
    },
    "text_tile_text_color": {
      "type": "string",
      "description": "Default text color for text tiles",
      "example": "example_value"
    },
    "tile_background_color": {
      "type": "string",
      "description": "Default background color for tiles",
      "example": "example_value"
    },
    "tile_text_color": {
      "type": "string",
      "description": "Default text color for tiles",
      "example": "example_value"
    },
    "hidden": {
      "type": "boolean",
      "description": "Whether the dashboard is hidden",
      "example": true
    },
    "refresh_interval": {
      "type": "string",
      "nullable": true,
      "description": "Auto-refresh interval",
      "example": "example_value"
    },
    "load_configuration": {
      "type": "string",
      "nullable": true,
      "description": "Tile load configuration",
      "example": "example_value"
    },
    "preferred_viewer": {
      "type": "string",
      "description": "Preferred viewer type",
      "example": "example_value"
    }
  }
}