Adobe Analytics · JSON Structure

Adobe Analytics Annotation Create Structure

Payload for creating an annotation

Type: object Properties: 5 Required: 2
AdobeAnalyticsBusiness IntelligenceCustomer IntelligenceDigital MarketingMarketingWeb Analytics

AnnotationCreate is a JSON Structure definition published by Adobe Analytics, describing 5 properties, of which 2 are required. It conforms to the https://json-structure.org/draft/2020-12/schema meta-schema.

Properties

name description dateRange rsids color

Meta-schema: https://json-structure.org/draft/2020-12/schema

JSON Structure

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