v1

latestOpenAPI 3.1.0Apache 2.02026-07-2685126228.9 KB

Query Annotations

List Query Annotations

List all Query Annotations in the specified dataset.

get/1/query_annotations/{datasetSlug}

Query parameters

include_board_annotationsboolean

Whether to include Query Annotations that were created from boards. By default, only Query Annotations created directly from queries are returned.

Response

Success

namestring required

A name for the Query.

descriptionstring

A description of the Query.

query_idstring required

The ID of the Query that the annotation describes. Note: Once created, it is NOT possible to change the query ID associated with an annotation. It is possible to have multiple annotations associated with a Query.

idstring

The unique identifier (ID) of a Query Annotation.

created_atstring date-time

ISO8601 formatted time when the Query Annotation was created.

updated_atstring date-time

ISO8601 formatted time when the Query Annotation was updated.

source'query' | 'board'

The source of the Query Annotation.

Example response

[
  {
    "name": "My Named Query",
    "description": "A nice description of My Named Query",
    "query_id": "mabAMpSPDjH",
    "id": "sGUnkBHgRFN",
    "created_at": "2022-10-26T21:36:04Z",
    "updated_at": "2022-12-04T08:14:26Z",
    "source": "query"
  }
]