Chart Annotation Lifecycle
A 4-step recipe with Amplitude. We can help you get access.
Recipe · 4 steps
Chart Annotation Lifecycle
with Amplitude
Create, read, update, and list a chart annotation.
- Create a new chart annotation with the supplied label, date, and optional category and chart association.
- Retrieve the newly created annotation by its ID to confirm it was created with the expected fields.
- Update the annotation's label and details. Only the supplied fields are changed; all other fields remain intact.
- List all annotations in the project to confirm the updated annotation is present in the collection.
What you'll need to have ready
- basicAuth: Base64-encoded api_key:secret_key credentials for HTTP Basic auth.
- label: The display label for the annotation.
- date: The date of the annotation in YYYY-MM-DD format.
- details: Additional details or notes for the annotation.
- category: The category to assign to the annotation.
- chartId: The ID of the chart to associate the annotation with. Omit for project-wide annotations.
- updatedLabel: The updated label to apply during the update step.
- updatedDetails: The updated details to apply during the update step.
For your developer
Arazzo workflow amplitude:annotation-lifecycle, 4 operations: createAnnotation → getAnnotation → updateAnnotation → listAnnotations. Specs on APIs.io.