Annotation

An annotation marking a date range in reports

AdobeAnalyticsBusiness IntelligenceCustomer IntelligenceDigital MarketingMarketingWeb Analytics

Properties

Name	Type	Description
id	string	Unique annotation identifier
name	string	Display name of the annotation
description	string	Annotation text content
dateRange	string	ISO 8601 date range covered by this annotation
rsids	array	List of report suite IDs this annotation applies to
color	string	Display color for the annotation in reports

View JSON Schema on GitHub

JSON Schema

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