Optimizely · Schema

Metric

A metric used to measure experiment results

A/B TestingContent ManagementCustomer DataE-CommerceExperimentationFeature FlagsMarketing

Properties

Name Type Description
event_id integer The event ID this metric tracks
aggregator string How to aggregate the metric
field string The field to aggregate on
scope string The scope of the metric
winning_direction string The direction that indicates improvement
View JSON Schema on GitHub

JSON Schema

optimizely-metric-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Metric",
  "title": "Metric",
  "type": "object",
  "description": "A metric used to measure experiment results",
  "properties": {
    "event_id": {
      "type": "integer",
      "format": "int64",
      "description": "The event ID this metric tracks"
    },
    "aggregator": {
      "type": "string",
      "description": "How to aggregate the metric",
      "enum": [
        "unique",
        "count",
        "sum"
      ]
    },
    "field": {
      "type": "string",
      "description": "The field to aggregate on"
    },
    "scope": {
      "type": "string",
      "description": "The scope of the metric",
      "enum": [
        "visitor",
        "session",
        "event"
      ]
    },
    "winning_direction": {
      "type": "string",
      "description": "The direction that indicates improvement",
      "enum": [
        "increasing",
        "decreasing"
      ]
    }
  }
}