Adobe Experience Cloud · JSON Structure

Experience Platform Api Segment Definition Input Structure

SegmentDefinitionInput schema

Type: object Properties: 5 Required: 4
AnalyticsCustomer ExperienceDigital MarketingPersonalizationCampaign ManagementJourney Orchestration

SegmentDefinitionInput is a JSON Structure definition published by Adobe Experience Cloud, describing 5 properties, of which 4 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

name description expression schema mergePolicyId

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/adobe-experience-cloud/refs/heads/main/json-structure/experience-platform-api-segment-definition-input-structure.json",
  "name": "SegmentDefinitionInput",
  "description": "SegmentDefinitionInput schema",
  "type": "object",
  "required": [
    "name",
    "expression",
    "schema",
    "mergePolicyId"
  ],
  "properties": {
    "name": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "expression": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "PQL"
          ]
        },
        "value": {
          "type": "string"
        },
        "format": {
          "type": "string",
          "enum": [
            "pql/text",
            "pql/json"
          ]
        }
      }
    },
    "schema": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        }
      }
    },
    "mergePolicyId": {
      "type": "string"
    }
  }
}