Component schema

ViewSpec

object1 direct reference

Definition

Views can exist in a variety of locations within the Dash0. The type defines where the view can be used, and consequently where it would appear as a selectable option.

"resources""services""spans""logs""metrics""failed_checks""web_events""sql""profiles""gcp_cloud_run_services""gcp_cloud_run_jobs""gcp_pubsub""gcp_cloud_storage""gcp_cloud_sql_instances""aws_lambda""slos"

ViewDisplayrequired

ViewPermission[]

string[]

A set of attribute keys to group the view by. This property may be missing to indicate that no configuration was historically made for this view, i.e., the view was saved before the grouping capability was added. In that case, you can assume a default grouping should be used.

FilterCriteria

The filter for the whole view.

FilterCriteria

An implicit filter the user cannot change that will always be applied to the view. It will not be shown in the UI.

ViewTable

ViewVisualization[]

A visualization configuration for the view. We only support a single visualization for now per view.

ViewSpecServiceMapProperties

string

The SQL query associated with this view. Only applicable when type is "sql". When the view is loaded, this query is used to populate the editor and auto-executed.

string

The selected service name for this view. Only applicable when type is "profiles". When the view is loaded, this service is pre-selected in the filter bar.

Used by 1

These schemas and endpoints reference this type directly.

SchemaViewDefinition

json

OpenAPI source123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657
{
  "properties": {
    "type": {
      "$ref": "#/components/schemas/ViewType",
      "description": "Views can exist in a variety of locations within the Dash0. The type defines\nwhere the view can be used, and consequently where it would appear as a selectable\noption.\n"
    },
    "display": {
      "$ref": "#/components/schemas/ViewDisplay"
    },
    "permissions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ViewPermission"
      }
    },
    "groupBy": {
      "description": "A set of attribute keys to group the view by. This property may be missing to indicate that\nno configuration was historically made for this view, i.e., the view was saved before the\ngrouping capability was added. In that case, you can assume a default grouping should be used.\n",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "filter": {
      "$ref": "#/components/schemas/FilterCriteria",
      "description": "The filter for the whole view.\n"
    },
    "implicitFilter": {
      "$ref": "#/components/schemas/FilterCriteria",
      "description": "An implicit filter the user cannot change that will always be applied to the view. It will not\nbe shown in the UI.\n"
    },
    "table": {
      "$ref": "#/components/schemas/ViewTable"
    },
    "visualizations": {
      "description": "A visualization configuration for the view. We only support a single visualization for now per view.\n",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ViewVisualization"
      }
    },
    "serviceMapProperties": {
      "$ref": "#/components/schemas/ViewSpecServiceMapProperties"
    },
    "query": {
      "description": "The SQL query associated with this view. Only applicable when type is \"sql\".\nWhen the view is loaded, this query is used to populate the editor and auto-executed.\n",
      "type": "string"
    },
    "serviceName": {
      "description": "The selected service name for this view. Only applicable when type is \"profiles\".\nWhen the view is loaded, this service is pre-selected in the filter bar.\n",
      "type": "string"
    }
  },
  "required": [
    "type",
    "display"
  ]
}