ReportFilter

A filter applied to a report

AdobeAnalyticsBusiness IntelligenceCustomer IntelligenceDigital MarketingMarketingWeb Analytics

Properties

Name	Type	Description
type	string	Filter type
dateRange	string	ISO 8601 date range (e.g. 2024-01-01T00:00:00/2024-01-31T23:59:59)
segmentId	string	ID of an existing segment to apply as a filter
dimension	string	Dimension for breakdown filter
itemId	string	Dimension item ID for breakdown filter

View JSON Schema on GitHub

JSON Schema

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