Amplitude · Schema
AnnotationListResponse
AnnotationListResponse schema from Amplitude Chart Annotations API
A/B TestingAnalyticsExperimentationFeature FlagsProduct AnalyticsUser Behavior
Properties
| Name | Type | Description |
|---|---|---|
| data | array | Array of annotation objects. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/amplitude/refs/heads/main/json-schema/chart-annotations-api-annotation-list-response-schema.json",
"title": "AnnotationListResponse",
"description": "AnnotationListResponse schema from Amplitude Chart Annotations API",
"type": "object",
"properties": {
"data": {
"type": "array",
"description": "Array of annotation objects.",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The unique identifier of the annotation."
},
"label": {
"type": "string",
"description": "The display label for the annotation."
},
"date": {
"type": "string",
"format": "date",
"description": "The start date of the annotation in YYYY-MM-DD format."
},
"end_date": {
"type": "string",
"format": "date",
"description": "The end date of the annotation for date ranges. Null for point-in-time annotations."
},
"details": {
"type": "string",
"description": "Additional details or notes for the annotation."
},
"category": {
"type": "string",
"description": "The category of the annotation for organization purposes."
},
"chart_id": {
"type": "integer",
"description": "The ID of the chart the annotation is associated with. Null for project-wide annotations."
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "The timestamp when the annotation was created."
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "The timestamp when the annotation was last updated."
}
}
}
}
}
}