PostHog · Schema

ScoreDefinitionCreate

A/B TestingAnalyticsFeature FlagsOpen SourceProduct AnalyticsSession Recording

Properties

Name	Type	Description
name	string	Human-readable scorer name.
description	string	Optional human-readable description.
kind	object	Scorer kind. This cannot be changed after creation. * `categorical` - categorical * `numeric` - numeric * `boolean` - boolean
archived	boolean	New scorers are always created as active.
config	object	Initial immutable scorer configuration.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ScoreDefinitionCreate",
  "title": "ScoreDefinitionCreate",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "Human-readable scorer name.",
      "maxLength": 255
    },
    "description": {
      "type": "string",
      "nullable": true,
      "description": "Optional human-readable description."
    },
    "kind": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ExperimentMetricKindEnum"
        }
      ],
      "description": "Scorer kind. This cannot be changed after creation.\n\n* `categorical` - categorical\n* `numeric` - numeric\n* `boolean` - boolean"
    },
    "archived": {
      "type": "boolean",
      "default": false,
      "description": "New scorers are always created as active."
    },
    "config": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ScoreDefinitionConfig"
        }
      ],
      "description": "Initial immutable scorer configuration."
    }
  },
  "required": [
    "config",
    "kind",
    "name"
  ]
}