AnnotationCreate

Payload for creating an annotation

AdobeAnalyticsBusiness IntelligenceCustomer IntelligenceDigital MarketingMarketingWeb Analytics

Properties

Name	Type	Description
name	string	Display name
description	string	Annotation notes
dateRange	string	ISO 8601 date range
rsids	array	Report suite IDs to apply to
color	string	Hex color code

View JSON Schema on GitHub

JSON Schema

{
  "type": "object",
  "description": "Payload for creating an annotation",
  "properties": {
    "name": {
      "type": "string",
      "description": "Display name",
      "example": "Example Title"
    },
    "description": {
      "type": "string",
      "description": "Annotation notes",
      "example": "A sample description."
    },
    "dateRange": {
      "type": "string",
      "description": "ISO 8601 date range",
      "example": "example_value"
    },
    "rsids": {
      "type": "array",
      "description": "Report suite IDs to apply to",
      "example": [],
      "items": {
        "type": "string"
      }
    },
    "color": {
      "type": "string",
      "description": "Hex color code",
      "example": "example_value"
    }
  },
  "required": [
    "name",
    "dateRange"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "AnnotationCreate"
}