PostHog · Schema

ExperimentRetentionMetric

A/B TestingAnalyticsFeature FlagsOpen SourceProduct AnalyticsSession Recording

Properties

Name	Type	Description
breakdownFilter	object
completion_event	object
conversion_window	integer
conversion_window_unit	object
fingerprint	string
goal	object
isSharedMetric	boolean
kind	string
metric_type	string
name	string
response	object
retention_window_end	integer
retention_window_start	integer
retention_window_unit	object
sharedMetricId	number
start_event	object
start_handling	object
uuid	string
version	number	version of the node, used for schema migrations

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ExperimentRetentionMetric",
  "title": "ExperimentRetentionMetric",
  "additionalProperties": false,
  "properties": {
    "breakdownFilter": {
      "default": null,
      "allOf": [
        {
          "$ref": "#/components/schemas/BreakdownFilter"
        }
      ],
      "nullable": true
    },
    "completion_event": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/EventsNode"
        },
        {
          "$ref": "#/components/schemas/ActionsNode"
        },
        {
          "$ref": "#/components/schemas/ExperimentDataWarehouseNode"
        }
      ],
      "title": "Completion Event"
    },
    "conversion_window": {
      "default": null,
      "title": "Conversion Window",
      "type": "integer",
      "nullable": true
    },
    "conversion_window_unit": {
      "default": null,
      "allOf": [
        {
          "$ref": "#/components/schemas/FunnelConversionWindowTimeUnit"
        }
      ],
      "nullable": true
    },
    "fingerprint": {
      "default": null,
      "title": "Fingerprint",
      "type": "string",
      "nullable": true
    },
    "goal": {
      "default": null,
      "allOf": [
        {
          "$ref": "#/components/schemas/ExperimentMetricGoal"
        }
      ],
      "nullable": true
    },
    "isSharedMetric": {
      "default": null,
      "title": "Issharedmetric",
      "type": "boolean",
      "nullable": true
    },
    "kind": {
      "default": "ExperimentMetric",
      "title": "Kind",
      "type": "string",
      "enum": [
        "ExperimentMetric"
      ]
    },
    "metric_type": {
      "default": "retention",
      "title": "Metric Type",
      "type": "string",
      "enum": [
        "retention"
      ]
    },
    "name": {
      "default": null,
      "title": "Name",
      "type": "string",
      "nullable": true
    },
    "response": {
      "default": null,
      "title": "Response",
      "additionalProperties": true,
      "type": "object",
      "nullable": true
    },
    "retention_window_end": {
      "title": "Retention Window End",
      "type": "integer"
    },
    "retention_window_start": {
      "title": "Retention Window Start",
      "type": "integer"
    },
    "retention_window_unit": {
      "$ref": "#/components/schemas/FunnelConversionWindowTimeUnit"
    },
    "sharedMetricId": {
      "default": null,
      "title": "Sharedmetricid",
      "type": "number",
      "nullable": true
    },
    "start_event": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/EventsNode"
        },
        {
          "$ref": "#/components/schemas/ActionsNode"
        },
        {
          "$ref": "#/components/schemas/ExperimentDataWarehouseNode"
        }
      ],
      "title": "Start Event"
    },
    "start_handling": {
      "$ref": "#/components/schemas/StartHandling"
    },
    "uuid": {
      "default": null,
      "title": "Uuid",
      "type": "string",
      "nullable": true
    },
    "version": {
      "default": null,
      "description": "version of the node, used for schema migrations",
      "title": "Version",
      "type": "number",
      "nullable": true
    }
  },
  "required": [
    "completion_event",
    "retention_window_end",
    "retention_window_start",
    "retention_window_unit",
    "start_event",
    "start_handling"
  ],
  "type": "object"
}