PostHog · Schema

Dashboard

Serializer mixin that handles tags for objects.

A/B TestingAnalyticsFeature FlagsOpen SourceProduct AnalyticsSession Recording

Properties

Name Type Description
id integer
name string
description string
pinned boolean
created_at string
created_by object
last_accessed_at string
last_viewed_at string
is_shared boolean
deleted boolean
creation_mode object
filters object
variables object
breakdown_colors object Custom color mapping for breakdown values.
data_color_theme_id integer ID of the color theme used for chart visualizations.
tags array
restriction_level object
effective_restriction_level object
effective_privilege_level object
user_access_level string The effective access level the user has for this object
access_control_version string
last_refresh string
persisted_filters object
persisted_variables object
team_id integer
quick_filter_ids array List of quick filter IDs associated with this dashboard
tiles array
use_template string Template key to create the dashboard from a predefined template.
use_dashboard integer ID of an existing dashboard to duplicate.
delete_insights boolean When deleting, also delete insights that are only on this dashboard.
_create_in_folder string
View JSON Schema on GitHub

JSON Schema

posthog-dashboard-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Dashboard",
  "title": "Dashboard",
  "type": "object",
  "description": "Serializer mixin that handles tags for objects.",
  "properties": {
    "id": {
      "type": "integer",
      "readOnly": true
    },
    "name": {
      "type": "string",
      "nullable": true,
      "maxLength": 400
    },
    "description": {
      "type": "string"
    },
    "pinned": {
      "type": "boolean"
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    },
    "created_by": {
      "allOf": [
        {
          "$ref": "#/components/schemas/UserBasic"
        }
      ],
      "readOnly": true
    },
    "last_accessed_at": {
      "type": "string",
      "format": "date-time",
      "nullable": true
    },
    "last_viewed_at": {
      "type": "string",
      "format": "date-time",
      "readOnly": true,
      "nullable": true
    },
    "is_shared": {
      "type": "boolean",
      "readOnly": true
    },
    "deleted": {
      "type": "boolean"
    },
    "creation_mode": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CreationModeEnum"
        }
      ],
      "readOnly": true
    },
    "filters": {
      "type": "object",
      "additionalProperties": true,
      "readOnly": true
    },
    "variables": {
      "type": "object",
      "additionalProperties": true,
      "nullable": true,
      "readOnly": true
    },
    "breakdown_colors": {
      "description": "Custom color mapping for breakdown values."
    },
    "data_color_theme_id": {
      "type": "integer",
      "nullable": true,
      "description": "ID of the color theme used for chart visualizations."
    },
    "tags": {
      "type": "array",
      "items": {}
    },
    "restriction_level": {
      "$ref": "#/components/schemas/RestrictionLevelEnum"
    },
    "effective_restriction_level": {
      "allOf": [
        {
          "$ref": "#/components/schemas/EffectivePrivilegeLevelEnum"
        }
      ],
      "readOnly": true
    },
    "effective_privilege_level": {
      "allOf": [
        {
          "$ref": "#/components/schemas/EffectivePrivilegeLevelEnum"
        }
      ],
      "readOnly": true
    },
    "user_access_level": {
      "type": "string",
      "nullable": true,
      "readOnly": true,
      "description": "The effective access level the user has for this object"
    },
    "access_control_version": {
      "type": "string",
      "readOnly": true
    },
    "last_refresh": {
      "type": "string",
      "format": "date-time",
      "nullable": true
    },
    "persisted_filters": {
      "type": "object",
      "additionalProperties": true,
      "nullable": true,
      "readOnly": true
    },
    "persisted_variables": {
      "type": "object",
      "additionalProperties": true,
      "nullable": true,
      "readOnly": true
    },
    "team_id": {
      "type": "integer",
      "readOnly": true
    },
    "quick_filter_ids": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "description": "List of quick filter IDs associated with this dashboard"
    },
    "tiles": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": true
      },
      "nullable": true,
      "readOnly": true
    },
    "use_template": {
      "type": "string",
      "writeOnly": true,
      "description": "Template key to create the dashboard from a predefined template."
    },
    "use_dashboard": {
      "type": "integer",
      "writeOnly": true,
      "nullable": true,
      "description": "ID of an existing dashboard to duplicate."
    },
    "delete_insights": {
      "type": "boolean",
      "writeOnly": true,
      "default": false,
      "description": "When deleting, also delete insights that are only on this dashboard."
    },
    "_create_in_folder": {
      "type": "string",
      "writeOnly": true,
      "title": " create in folder"
    }
  },
  "required": [
    "access_control_version",
    "created_at",
    "created_by",
    "creation_mode",
    "effective_privilege_level",
    "effective_restriction_level",
    "filters",
    "id",
    "is_shared",
    "last_viewed_at",
    "persisted_filters",
    "persisted_variables",
    "team_id",
    "tiles",
    "user_access_level",
    "variables"
  ]
}