HOhoneycomb
Boards

Get a Board

Changed on

Get a single Board by ID.

get/1/boards/{boardId}

Request

  • Base URL
    https://api.honeycomb.io
  • URL
    https://api.honeycomb.io/1/boards/{boardId}
  • Auth
    API key in header X-Honeycomb-Team

Response

Success

namestring required

The name of the Board.

descriptionstring

A description of the Board.

type'flexible' required

The type of the board. Only flexible boards are supported.

idstring

Unique identifier (ID), returned in response bodies.

layout_generation'auto' | 'manual'

The layout generation mode for the board. When set to "auto", the board will be automatically laid out based on the panels. When set to "manual", the board will be laid out manually by the user.

Example response

{
  "name": "My Board",
  "description": "A board created via the API",
  "links": {
    "board_url": "https://ui.honeycomb.io/myteam/environments/myenvironment/board/2NeeaE9bBLd"
  },
  "id": "2NeeaE9bBLd",
  "panels": [
    {
      "query_panel": {
        "query_id": "abc1234e",
        "query_annotation_id": "e4c24a35",
        "dataset": "My Dataset",
        "visualization_settings": {
          "charts": [
            {
              "thresholds": [
                {
                  "value": 100,
                  "label": "Critical",
                  "color": "red",
                  "operation": "gt",
                  "line_style": "filled-solid"
                }
              ]
            }
          ]
        }
      }
    }
  ],
  "tags": [
    {
      "key": "team",
      "value": "blue"
    }
  ],
  "preset_filters": [
    {
      "column": "app.Service",
      "alias": "Service"
    }
  ]
}

Changes

  • 276c5555582aRevision changes
    • info

      added query slo text discriminator mapping keys to the / response property for the response status