BehaviourTagCreateRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/dream-sports/json-schema/dream-sports-behaviour-tag-create-request-schema.json",
  "title": "BehaviourTagCreateRequest",
  "description": "Request to create a new Behaviour Tag",
  "x-generated": "2026-11-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/dream-sports-behaviour-tags-api-openapi.yml#/components/schemas/BehaviourTagCreateRequest",
  "type": "object",
  "required": [
    "behaviourTagName",
    "exposureRule",
    "ctaRelation"
  ],
  "properties": {
    "behaviourTagName": {
      "type": "string",
      "description": "Name of the Behaviour Tag"
    },
    "description": {
      "type": "string",
      "description": "Description of the Behaviour Tag"
    },
    "exposureRule": {
      "description": "Exposure rules defining when this behaviour tag applies to users. Includes session, window, and lifespan frequency limits.",
      "type": "object",
      "$ref": "#/$defs/ExposureRule"
    },
    "ctaRelation": {
      "description": "CTA relation rules defining which CTAs are shown/hidden for this behaviour tag. shownCta defines which CTAs to show (rule: LIST/ANY/NONE), hideCta defines which CTAs to hide (rule: LIST/ANY/NONE).",
      "type": "object",
      "$ref": "#/$defs/CTARelation"
    },
    "linkedCtas": {
      "type": "array",
      "uniqueItems": true,
      "items": {
        "type": "string"
      },
      "description": "Set of CTA IDs linked to this behaviour tag"
    }
  },
  "$defs": {
    "CTARelation": {
      "type": "object",
      "properties": {
        "shownCta": {
          "$ref": "#/$defs/CtaRelationRule"
        },
        "hideCta": {
          "$ref": "#/$defs/CtaRelationRule"
        }
      }
    },
    "CtaRelationRule": {
      "type": "object",
      "properties": {
        "rule": {
          "$ref": "#/$defs/CtaRelationRuleTypes"
        },
        "ctaList": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string"
          }
        }
      }
    },
    "CtaRelationRuleTypes": {
      "type": "string",
      "enum": [
        "ANY",
        "LIST",
        "REST"
      ]
    },
    "ExposureRule": {
      "type": "object",
      "properties": {
        "session": {
          "$ref": "#/$defs/SessionFrequency"
        },
        "window": {
          "$ref": "#/$defs/WindowFrequency"
        },
        "lifespan": {
          "$ref": "#/$defs/LifespanFrequency"
        }
      }
    },
    "LifespanFrequency": {
      "type": "object",
      "required": [
        "limit"
      ],
      "properties": {
        "limit": {
          "type": "integer",
          "format": "int32"
        }
      }
    },
    "SessionFrequency": {
      "type": "object",
      "required": [
        "limit"
      ],
      "properties": {
        "limit": {
          "type": "integer",
          "format": "int32"
        }
      }
    },
    "WindowFrequency": {
      "type": "object",
      "required": [
        "limit",
        "unit",
        "value"
      ],
      "properties": {
        "limit": {
          "type": "integer",
          "format": "int32"
        },
        "unit": {
          "$ref": "#/$defs/WindowFrequencyUnit"
        },
        "value": {
          "type": "integer",
          "format": "int32"
        }
      }
    },
    "WindowFrequencyUnit": {
      "type": "string",
      "enum": [
        "days",
        "hours",
        "minutes",
        "seconds"
      ]
    }
  }
}