honeycomb · Schema

BoardQuery

Properties

Name Type Description
query_id string The ID of the query specification.
dataset string The dataset slug to run the query against.
query_annotation_id string The ID of an associated query annotation.
caption string A display caption for the query on the board.
query_style string The visualization style for the query.
graph_settings object Settings for graph rendering.
View JSON Schema on GitHub

JSON Schema

honeycomb-boardquery-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/BoardQuery",
  "title": "BoardQuery",
  "type": "object",
  "properties": {
    "query_id": {
      "type": "string",
      "description": "The ID of the query specification."
    },
    "dataset": {
      "type": "string",
      "description": "The dataset slug to run the query against."
    },
    "query_annotation_id": {
      "type": "string",
      "description": "The ID of an associated query annotation."
    },
    "caption": {
      "type": "string",
      "description": "A display caption for the query on the board."
    },
    "query_style": {
      "type": "string",
      "description": "The visualization style for the query.",
      "enum": [
        "graph",
        "table",
        "combo"
      ]
    },
    "graph_settings": {
      "type": "object",
      "description": "Settings for graph rendering."
    }
  }
}