Amplitude · JSON Structure

Chart Annotations Api Annotation List Response Structure

AnnotationListResponse schema from Amplitude Chart Annotations API

Type: object Properties: 1
A/B TestingAnalyticsExperimentationFeature FlagsProduct AnalyticsUser Behavior

AnnotationListResponse is a JSON Structure definition published by Amplitude, describing 1 property. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

data

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amplitude/refs/heads/main/json-structure/chart-annotations-api-annotation-list-response-structure.json",
  "name": "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": "int32",
            "description": "The unique identifier of the annotation."
          },
          "label": {
            "type": "string",
            "description": "The display label for the annotation."
          },
          "date": {
            "type": "date",
            "description": "The start date of the annotation in YYYY-MM-DD format."
          },
          "end_date": {
            "type": "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": "int32",
            "description": "The ID of the chart the annotation is associated with. Null for project-wide annotations."
          },
          "created_at": {
            "type": "datetime",
            "description": "The timestamp when the annotation was created."
          },
          "updated_at": {
            "type": "datetime",
            "description": "The timestamp when the annotation was last updated."
          }
        }
      }
    }
  }
}