AB Tasty · Schema

Campaign

Campaign schema from AB Tasty Decision API

AggregationExperimentationFeature FlagsPersonalizationA/B Testing

Properties

Name Type Description
id string Campaign ID
variationGroupId string Variation group ID (corresponds to a scenario in Flagship)
variation object
View JSON Schema on GitHub

JSON Schema

decision-api-campaign-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/ab-tasty/refs/heads/main/json-schema/decision-api-campaign-schema.json",
  "title": "Campaign",
  "description": "Campaign schema from AB Tasty Decision API",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Campaign ID",
      "example": "campaign_abc"
    },
    "variationGroupId": {
      "type": "string",
      "description": "Variation group ID (corresponds to a scenario in Flagship)",
      "example": "vg_123"
    },
    "variation": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "Variation ID",
          "example": "var_456"
        },
        "modifications": {
          "type": "object",
          "properties": {
            "type": {
              "type": "string",
              "enum": [
                "NULL",
                "JSON",
                "TEXT",
                "IMAGE",
                "HTML",
                "FLAG",
                "REDIRECT"
              ],
              "description": "The modification type"
            },
            "value": {
              "oneOf": [
                {
                  "type": "object"
                },
                {
                  "type": "string"
                }
              ],
              "description": "The value of the modification (structure depends on type)",
              "example": {
                "button_color": "blue",
                "feature_enabled": true
              }
            }
          }
        }
      }
    }
  }
}