Adobe Analytics · JSON Structure

Adobe Analytics Annotation Structure

An annotation marking a date range in reports

Type: object Properties: 6
AdobeAnalyticsBusiness IntelligenceCustomer IntelligenceDigital MarketingMarketingWeb Analytics

Annotation is a JSON Structure definition published by Adobe Analytics, describing 6 properties. It conforms to the https://json-structure.org/draft/2020-12/schema meta-schema.

Properties

id name description dateRange rsids color

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

JSON Structure

Raw ↑ 
{
  "type": "object",
  "description": "An annotation marking a date range in reports",
  "name": "Annotation",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique annotation identifier"
    },
    "name": {
      "type": "string",
      "description": "Display name of the annotation"
    },
    "description": {
      "type": "string",
      "description": "Annotation text content"
    },
    "dateRange": {
      "type": "string",
      "description": "ISO 8601 date range covered by this annotation"
    },
    "rsids": {
      "type": "array",
      "description": "List of report suite IDs this annotation applies to",
      "items": {
        "type": "string"
      }
    },
    "color": {
      "type": "string",
      "description": "Display color for the annotation in reports"
    }
  },
  "$schema": "https://json-structure.org/draft/2020-12/schema"
}