Amplitude · JSON Structure

Chart Annotations Api Create Annotation Request Structure

CreateAnnotationRequest schema from Amplitude Chart Annotations API

Type: object Properties: 6 Required: 2
A/B TestingAnalyticsExperimentationFeature FlagsProduct AnalyticsUser Behavior

CreateAnnotationRequest is a JSON Structure definition published by Amplitude, describing 6 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

label date end_date details category chart_id

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-create-annotation-request-structure.json",
  "name": "CreateAnnotationRequest",
  "description": "CreateAnnotationRequest schema from Amplitude Chart Annotations API",
  "type": "object",
  "properties": {
    "label": {
      "type": "string",
      "description": "The display label for the annotation.",
      "maxLength": 255
    },
    "date": {
      "type": "date",
      "description": "The date of the annotation in YYYY-MM-DD format."
    },
    "end_date": {
      "type": "date",
      "description": "The end date for date-range annotations in YYYY-MM-DD format."
    },
    "details": {
      "type": "string",
      "description": "Additional details or notes for the annotation."
    },
    "category": {
      "type": "string",
      "description": "The category to assign to the annotation."
    },
    "chart_id": {
      "type": "int32",
      "description": "The ID of the chart to associate the annotation with. Omit for project-wide annotations."
    }
  },
  "required": [
    "label",
    "date"
  ]
}