create_annotation
Add a time-based annotation to an existing annotation layer on a time-series chart. Specify the layer ID, label, start and end datetimes to mark a period.
Instructions
Add an annotation to an existing annotation layer.
Annotations are time-based markers that overlay on time-series charts. Use list_annotation_layers or get_annotation_layer to find layer IDs.
Args: layer_id: The annotation layer ID to add this annotation to. short_descr: Short description (label) shown on the chart overlay. start_dttm: Start datetime in ISO 8601 format (e.g. '2024-01-15T00:00:00'). end_dttm: End datetime in ISO 8601 format (e.g. '2024-01-16T00:00:00'). long_descr: Optional longer description with details. dry_run: If True, preview the action without executing.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| layer_id | Yes | ||
| short_descr | Yes | ||
| start_dttm | Yes | ||
| end_dttm | Yes | ||
| long_descr | No | ||
| dry_run | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |