Boards are a place to pin and save useful queries and graphs you want to retain for later reuse and reference.
This API allows you to list, create, update, and delete Boards.
The API key must have the Manage Public Boards permission. Learn more about API keys here.
Create a Board
Create a Board comprised of one or more Queries.
Securityapi_key
Request
Request Body schema: application/jsonrequired
Responses
201
Created
401
Unauthorized
422
Invalid Board
default
Error
post/1/boards
Request samples
- Payload
- curl
application/json
{- "name": "My Board",
- "description": "A board created via the API",
- "style": "visual",
- "column_layout": "multi",
- "queries": [
- {
- "caption": "context for this query",
- "graph_settings": {
- "hide_markers": false,
- "log_scale": false,
- "omit_missing_values": false,
- "stacked_graphs": false,
- "utc_xaxis": false,
- "overlaid_charts": false
}, - "query_style": "graph",
- "dataset": "My Dataset",
- "query_id": "abc1234e",
- "query": null,
- "query_annotation_id": "e4c24a35"
}
]
}Response samples
- 201
- 401
- 422
- default
application/json
{- "name": "My Board",
- "description": "A board created via the API",
- "style": "visual",
- "column_layout": "multi",
- "queries": [
- {
- "caption": "context for this query",
- "graph_settings": {
- "hide_markers": false,
- "log_scale": false,
- "omit_missing_values": false,
- "stacked_graphs": false,
- "utc_xaxis": false,
- "overlaid_charts": false
}, - "query_style": "graph",
- "dataset": "My Dataset",
- "query_id": "abc1234e",
- "query_annotation_id": "e4c24a35"
}
], - "links": {
}, - "id": "2NeeaE9bBLd"
}List All Boards
Retrieves a list of all non-secret Boards within an environment. Note: For Honeycomb Classic users, all boards within Classic will be returned.
Securityapi_key
Responses
200
Success
401
Unauthorized
default
Error
get/1/boards
Request samples
- curl
Response samples
- 200
- 401
- default
application/json
[- {
- "name": "My Board",
- "description": "A board created via the API",
- "style": "visual",
- "column_layout": "multi",
- "queries": [
- {
- "caption": "context for this query",
- "graph_settings": {
- "hide_markers": false,
- "log_scale": false,
- "omit_missing_values": false,
- "stacked_graphs": false,
- "utc_xaxis": false,
- "overlaid_charts": false
}, - "query_style": "graph",
- "dataset": "My Dataset",
- "query_id": "abc1234e",
- "query_annotation_id": "e4c24a35"
}
], - "links": {
}, - "id": "2NeeaE9bBLd"
}
]Get a Board
Get a single Board by ID.
Securityapi_key
Responses
200
Success
401
Unauthorized
404
Not Found
default
Error
get/1/boards/{boardId}
Request samples
- curl
Response samples
- 200
- 401
- 404
- default
application/json
{- "name": "My Board",
- "description": "A board created via the API",
- "style": "visual",
- "column_layout": "multi",
- "queries": [
- {
- "caption": "context for this query",
- "graph_settings": {
- "hide_markers": false,
- "log_scale": false,
- "omit_missing_values": false,
- "stacked_graphs": false,
- "utc_xaxis": false,
- "overlaid_charts": false
}, - "query_style": "graph",
- "dataset": "My Dataset",
- "query_id": "abc1234e",
- "query_annotation_id": "e4c24a35"
}
], - "links": {
}, - "id": "2NeeaE9bBLd"
}Update a Board
Update a Board by specifying its ID and full details.
Note: Queries can be added to, removed from, and re-ordered by updating the board itself. It is not possible to reference individual queries via the API.
Securityapi_key
Request
Request Body schema: application/jsonrequired
Responses
200
Success
401
Unauthorized
404
Not Found
422
Invalid Board
default
Error
put/1/boards/{boardId}
Request samples
- Payload
- curl
application/json
{- "name": "My Board",
- "description": "A board created via the API",
- "style": "visual",
- "column_layout": "multi",
- "queries": [
- {
- "caption": "context for this query",
- "graph_settings": {
- "hide_markers": false,
- "log_scale": false,
- "omit_missing_values": false,
- "stacked_graphs": false,
- "utc_xaxis": false,
- "overlaid_charts": false
}, - "query_style": "graph",
- "dataset": "My Dataset",
- "query_id": "abc1234e",
- "query": null,
- "query_annotation_id": "e4c24a35"
}
]
}Response samples
- 200
- 401
- 404
- 422
- default
application/json
{- "name": "My Board",
- "description": "A board created via the API",
- "style": "visual",
- "column_layout": "multi",
- "queries": [
- {
- "caption": "context for this query",
- "graph_settings": {
- "hide_markers": false,
- "log_scale": false,
- "omit_missing_values": false,
- "stacked_graphs": false,
- "utc_xaxis": false,
- "overlaid_charts": false
}, - "query_style": "graph",
- "dataset": "My Dataset",
- "query_id": "abc1234e",
- "query_annotation_id": "e4c24a35"
}
], - "links": {
}, - "id": "2NeeaE9bBLd"
}