Amplitude · Schema

CreateAnnotationRequest

A/B TestingAnalyticsExperimentationFeature FlagsProduct AnalyticsUser Behavior

Properties

Name	Type	Description
label	string	The display label for the annotation.
date	string	The date of the annotation in YYYY-MM-DD format.
end_date	string	The end date for date-range annotations in YYYY-MM-DD format.
details	string	Additional details or notes for the annotation.
category	string	The category to assign to the annotation.
chart_id	integer	The ID of the chart to associate the annotation with. Omit for project-wide annotations.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CreateAnnotationRequest",
  "title": "CreateAnnotationRequest",
  "type": "object",
  "required": [
    "label",
    "date"
  ],
  "properties": {
    "label": {
      "type": "string",
      "description": "The display label for the annotation.",
      "maxLength": 255
    },
    "date": {
      "type": "string",
      "format": "date",
      "description": "The date of the annotation in YYYY-MM-DD format."
    },
    "end_date": {
      "type": "string",
      "format": "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": "integer",
      "description": "The ID of the chart to associate the annotation with. Omit for project-wide annotations."
    }
  }
}