PostHog · Schema

RetentionEntity

A/B TestingAnalyticsFeature FlagsOpen SourceProduct AnalyticsSession Recording

Properties

Name	Type	Description
aggregation_target_field	string	Data warehouse field used as the actor identifier
custom_name	string
id	object
kind	object
name	string
order	integer
properties	array	filters on the event
table_name	string	Data warehouse table name
timestamp_field	string	Data warehouse timestamp field
type	object
uuid	string

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/RetentionEntity",
  "title": "RetentionEntity",
  "additionalProperties": false,
  "properties": {
    "aggregation_target_field": {
      "default": null,
      "description": "Data warehouse field used as the actor identifier",
      "title": "Aggregation Target Field",
      "type": "string",
      "nullable": true
    },
    "custom_name": {
      "default": null,
      "title": "Custom Name",
      "type": "string",
      "nullable": true
    },
    "id": {
      "default": null,
      "title": "Id",
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "number"
        }
      ],
      "nullable": true
    },
    "kind": {
      "default": null,
      "allOf": [
        {
          "$ref": "#/components/schemas/RetentionEntityKind"
        }
      ],
      "nullable": true
    },
    "name": {
      "default": null,
      "title": "Name",
      "type": "string",
      "nullable": true
    },
    "order": {
      "default": null,
      "title": "Order",
      "type": "integer",
      "nullable": true
    },
    "properties": {
      "default": null,
      "description": "filters on the event",
      "title": "Properties",
      "items": {
        "anyOf": [
          {
            "$ref": "#/components/schemas/EventPropertyFilter"
          },
          {
            "$ref": "#/components/schemas/PersonPropertyFilter"
          },
          {
            "$ref": "#/components/schemas/ElementPropertyFilter"
          },
          {
            "$ref": "#/components/schemas/EventMetadataPropertyFilter"
          },
          {
            "$ref": "#/components/schemas/SessionPropertyFilter"
          },
          {
            "$ref": "#/components/schemas/CohortPropertyFilter"
          },
          {
            "$ref": "#/components/schemas/RecordingPropertyFilter"
          },
          {
            "$ref": "#/components/schemas/LogEntryPropertyFilter"
          },
          {
            "$ref": "#/components/schemas/GroupPropertyFilter"
          },
          {
            "$ref": "#/components/schemas/FeaturePropertyFilter"
          },
          {
            "$ref": "#/components/schemas/FlagPropertyFilter"
          },
          {
            "$ref": "#/components/schemas/HogQLPropertyFilter"
          },
          {
            "$ref": "#/components/schemas/EmptyPropertyFilter"
          },
          {
            "$ref": "#/components/schemas/DataWarehousePropertyFilter"
          },
          {
            "$ref": "#/components/schemas/DataWarehousePersonPropertyFilter"
          },
          {
            "$ref": "#/components/schemas/ErrorTrackingIssueFilter"
          },
          {
            "$ref": "#/components/schemas/LogPropertyFilter"
          },
          {
            "$ref": "#/components/schemas/SpanPropertyFilter"
          },
          {
            "$ref": "#/components/schemas/RevenueAnalyticsPropertyFilter"
          },
          {
            "$ref": "#/components/schemas/WorkflowVariablePropertyFilter"
          }
        ]
      },
      "type": "array",
      "nullable": true
    },
    "table_name": {
      "default": null,
      "description": "Data warehouse table name",
      "title": "Table Name",
      "type": "string",
      "nullable": true
    },
    "timestamp_field": {
      "default": null,
      "description": "Data warehouse timestamp field",
      "title": "Timestamp Field",
      "type": "string",
      "nullable": true
    },
    "type": {
      "default": null,
      "allOf": [
        {
          "$ref": "#/components/schemas/EntityType"
        }
      ],
      "nullable": true
    },
    "uuid": {
      "default": null,
      "title": "Uuid",
      "type": "string",
      "nullable": true
    }
  },
  "type": "object"
}