Adobe Analytics · JSON Structure

Adobe Analytics Report Filter Structure

A filter applied to a report

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

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

Properties

type dateRange segmentId dimension itemId

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

JSON Structure

Raw ↑ 
{
  "type": "object",
  "description": "A filter applied to a report",
  "name": "ReportFilter",
  "properties": {
    "type": {
      "type": "string",
      "description": "Filter type",
      "enum": [
        "dateRange",
        "breakdown",
        "segment"
      ]
    },
    "dateRange": {
      "type": "string",
      "description": "ISO 8601 date range (e.g. 2024-01-01T00:00:00/2024-01-31T23:59:59)"
    },
    "segmentId": {
      "type": "string",
      "description": "ID of an existing segment to apply as a filter"
    },
    "dimension": {
      "type": "string",
      "description": "Dimension for breakdown filter"
    },
    "itemId": {
      "type": "string",
      "description": "Dimension item ID for breakdown filter"
    }
  },
  "required": [
    "type"
  ],
  "$schema": "https://json-structure.org/draft/2020-12/schema"
}