Adobe Analytics · Schema

ReportMetric

A metric included in a report request

AdobeAnalyticsBusiness IntelligenceCustomer IntelligenceDigital MarketingMarketingWeb Analytics

Properties

Name Type Description
id string The metric ID (e.g. metrics/visits)
columnId string Column identifier for this metric in the response
filters array Metric-level filter IDs referencing metricFilters
sort string Sort direction for this metric
View JSON Schema on GitHub

JSON Schema

adobe-analytics-report-metric-schema.json Raw ↑
{
  "type": "object",
  "description": "A metric included in a report request",
  "properties": {
    "id": {
      "type": "string",
      "description": "The metric ID (e.g. metrics/visits)",
      "example": "abc123"
    },
    "columnId": {
      "type": "string",
      "description": "Column identifier for this metric in the response",
      "example": "500123"
    },
    "filters": {
      "type": "array",
      "description": "Metric-level filter IDs referencing metricFilters",
      "example": [],
      "items": {
        "type": "string"
      }
    },
    "sort": {
      "type": "string",
      "description": "Sort direction for this metric",
      "example": "ASC",
      "enum": [
        "ASC",
        "DESC"
      ]
    }
  },
  "required": [
    "id"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "ReportMetric"
}