Annotations

Create an annotation

Creates a new annotation.

post/analytics/v1/annotations

Request

  • Base URL
    https://api.doit.com
  • URL
    https://api.doit.com/analytics/v1/annotations
  • Auth
    • API key in header Authorization
    • or API key in header X-Tenant-Id and API key in header Authorization

Request body

contentstring required

The content of the annotation.

timestampstring date-time required

The date associated with the annotation.

reportsstring[]

List of report IDs associated with the annotation.

labelsstring[]

List of label IDs to associate with the annotation. Labels must already exist.

Response

Created - Annotation created successfully.

idstring required

The unique identifier of the annotation.

contentstring required

The content of the annotation.

timestampstring date-time required

The date associated with the annotation.

reportsstring[]

List of report IDs associated with the annotation.

createTimestring date-time

The creation time of the annotation.

updateTimestring date-time

The time when the annotation was last updated.

Changes

No recorded changes to this operation across all 1 revision of this API.