Query dashboard annotations

thammr · February 7, 2022, 8:06am

I just upgraded to 2.1 and I love the new dashboard annotation feature. I would like to be able to remotely obtain the annotations. I am currently using python InfluxDBClient to obtain my time-series data. Is it possible to similarly retrieve the annotation data?

Anaisdg · February 8, 2022, 6:13pm

Hello @thammr,
Welcome!
You could use requests and the following openapi spec

github.com

influxdata/openapi/blob/master/contracts/svc/annotationd.yml

openapi: 3.0.0
info:
  title: Annotations service
  version: 0.2.3
  license:
    name: MIT
    url: 'https://opensource.org/licenses/MIT'
servers:
  - url: /
paths:
  /annotations:
    post:
      tags:
        - Annotations
      operationId: createAnnotations
      summary: Create annotations
      requestBody:
        description: Annotations to create
        content:
          application/json:

This file has been truncated. show original

thammr · February 19, 2022, 3:21am

Sorry, I just saw your reply as Outlook placed it in the junk folder.
By eavesdropping on the communication between the browser and influxdb, I discovered the url:

http://myhost:8086/api/v2private/annotations?AnnotationListFilter=&orgID=

This seems to correspond to:

github.com

influxdata/openapi/blob/master/contracts/priv/annotationd.yml

openapi: 3.0.0
info:
  title: Annotations service
  version: 0.2.3
  license:
    name: MIT
    url: 'https://opensource.org/licenses/MIT'
servers:
  - url: /api/v2private
paths:
  /annotations:
    post:
      tags:
        - Annotations
      operationId: createAnnotations
      summary: Create annotations
      requestBody:
        description: Annotations to create
        content:
          application/json:

This file has been truncated. show original

Cannot work out how to access the one you provided, but the functionality of both seems the same.

Topic		Replies	Views
Chronograf annotations api Dashboards chronograf	3	1435	March 21, 2021
Getting HTML response while querying the data from the InfluxDB using the Python InfluxDB 2 influxdb , flux	1	183	April 24, 2024
Import influx dashboard from json with queries included Dashboards	0	11	November 21, 2024
Influx 2 python library connect to InfluxData cloud InfluxDB 2 influxdata , influxdb-cloud-2-0	2	864	October 11, 2019
Influx DB - Flux query InfluxDB 2 influxdb , query , flux	5	1132	November 23, 2020

Query dashboard annotations

Related topics