v1

latestOpenAPI 3.0.12026-07-26152262362.2 KB
Annotations

Update an annotation

Updates the annotation specified by the Id.

patch/analytics/v1/annotations/{id}

Path parameters

idstring required

Annotation ID

Request body

contentstring nullable

The content of the annotation.

timestampstring date-time nullable

The date associated with the annotation.

reportsstring[] nullable

List of report IDs associated with the annotation.

labelsstring[] nullable

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

Response

OK - Annotation updated.

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.