Amplitude · Schema

Segment

Segment schema from Amplitude Experiment Management API

A/B TestingAnalyticsExperimentationFeature FlagsProduct AnalyticsUser Behavior

Properties

Name Type Description
name string The display name of the segment.
conditions array Array of targeting conditions that define this segment.
variant string The variant key to assign when this segment matches.
percentage integer The percentage of matching users to include (0-100).
View JSON Schema on GitHub

JSON Schema

experiment-management-api-segment-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amplitude/refs/heads/main/json-schema/experiment-management-api-segment-schema.json",
  "title": "Segment",
  "description": "Segment schema from Amplitude Experiment Management API",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The display name of the segment."
    },
    "conditions": {
      "type": "array",
      "description": "Array of targeting conditions that define this segment.",
      "items": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "description": "The condition type."
          },
          "prop": {
            "type": "string",
            "description": "The property to evaluate."
          },
          "op": {
            "type": "string",
            "description": "The comparison operator."
          },
          "values": {
            "type": "array",
            "description": "The values to compare against.",
            "items": {
              "type": "string"
            }
          }
        }
      }
    },
    "variant": {
      "type": "string",
      "description": "The variant key to assign when this segment matches."
    },
    "percentage": {
      "type": "integer",
      "description": "The percentage of matching users to include (0-100).",
      "minimum": 0,
      "maximum": 100
    }
  }
}