Anchor to AnalyticsAnnotationUpdateInputAnalytics
input_objectAnalytics Annotation Update Input
The input fields for updating an analytics annotation. Only the fields you provide are changed.
Anchor to FieldsFields
- description (String)
- endedAt (DateTime)
- startedAt (DateTime)
- title (String)
- type (String)
- Anchor to descriptiondescription•String
A plain-text description that provides additional context. The maximum length is 150 characters. Set to
nullto remove the description.- Anchor to endedAtended•Date
At Time The date and time when the annotation ended. Set to
nullfor open-ended annotations.- Anchor to startedAtstarted•Date
At Time The date and time when the annotation started.
- Anchor to titletitle•String
The title of the annotation, displayed on the chart marker. The maximum length is 75 characters.
- Anchor to typetype•String
A supported type for an app-created annotation. Refer to the list of supported types.
Was this section helpful?