INinfluxdata
sources
annotations

GET /sources/{id}/annotations/

Changed on

Retrieve a list of user-defined annotations.

Request

  • Base URL
    /chronograf/v1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /chronograf/v1/sources/{id}/annotations/
  • Auth
    none declared

Path parameters

idstring required

ID of the source

Query parameters

sincestring required

RFC3339 datetime to retrieve annotations after

untilstring

RFC3339 datetime to retrieve annotations until (defaults to now if not supplied)

tagstring

An InfluxQL binary expression for querying annotations by their tags

Response

List of annotations

Example response

{
  "annotations": [
    {
      "id": "50ee18e8-8115-4fac-abed-24ce89e96047",
      "startTime": "2018-07-09T18:08:15.933Z",
      "endTime": "2018-07-09T18:08:15.933Z",
      "text": "unknown event",
      "color": "",
      "tags": {},
      "links": {
        "self": "/chronograf/v1/sources/1/annotations/50ee18e8-8115-4fac-abed-24ce89e96047"
      }
    },
    {
      "id": "59434c1c-fa16-40e9-8b92-af71544cc3eb",
      "startTime": "2018-07-09T17:48:04.23Z",
      "endTime": "2018-07-09T17:48:08.652Z",
      "text": "todo: investigate this spike",
      "color": "",
      "tags": {
        "repo": "influxdata/chronograf"
      },
      "links": {
        "self": "/chronograf/v1/sources/1/annotations/59434c1c-fa16-40e9-8b92-af71544cc3eb"
      }
    }
  ]
}

Changes