TAtalon
Experiments

Get experiment in Application

Changed on

[!note] Management API endpoints are not meant to be used in real-time integrations that directly serve your end users. Rate limit: 3 requests per second.

Retrieve the given experiment associated with the Application.

get/v1/applications/{applicationId}/experiments/{experimentId}

Request

Path parameters

applicationIdinteger required

The ID of the Application. It is displayed in your Talon.One deployment URL.

experimentIdinteger required

The ID of the experiment.

Response

OK

idinteger required

The internal ID of this entity.

createdstring date-time required

The time this entity was created.

applicationIdinteger required

The ID of the Application that owns this entity.

assignmentType'random' | 'external' | 'audience'

Controls how customers are assigned to experiment variants. - random: Talon.One assigns customers randomly based on variant weights. - external: Variant assignment is handled externally. - audience: Each variant targets a specific audience; customers are assigned based on audience membership.

isVariantAssignmentExternalboolean

Deprecated. Use assignmentType instead. - false - The variant assignment is handled internally by Talon.One. - true - The variant assignment is handled externally.

activatedstring date-time

The date and time the experiment was activated.

state'enabled' | 'disabled' | 'archived' required

A disabled experiment is not evaluated for rules or coupons.

goalType'other' | 'maximize_revenue' | 'optimize_discount_efficiency' | 'maximize_items_sold' required

The goal of the experiment. Determines which single metric is used to decide the winning variant. When set to other, multiple metrics are used.

goalDescriptionstring

A description of the experiment goal. Provides context for the AI summary and helps it interpret the outcome of the experiment against the stated goal.

deletedatstring date-time

The date and time the experiment was deleted.

Example response

{
  "id": 6,
  "created": "2020-06-10T09:05:27.993483Z",
  "applicationId": 322,
  "assignmentType": "random",
  "campaign": {
    "id": 4,
    "created": "2020-06-10T09:05:27.993483Z",
    "applicationId": 322,
    "userId": 388,
    "name": "Summer promotions",
    "description": "Campaign for all summer 2021 promotions",
    "startTime": "2021-07-20T22:00:00Z",
    "endTime": "2021-09-22T22:00:00Z",
    "state": "enabled",
    "activeRulesetId": 6,
    "tags": [
      "summer"
    ],
    "reevaluateOnReturn": true,
    "features": [
      "coupons",
      "referrals"
    ],
    "couponSettings": {
      "validCharacters": [
        "A",
        "B",
        "C",
        "D",
        "E",
        "F",
        "G",
        "H",
        "I",
        "J",
        "K",
        "L",
        "M",
        "N",
        "O",
        "P",
        "Q",
        "R",
        "S",
        "T",
        "U",
        "V",
        "W",
        "X",
        "Y",
        "Z",
        "0",
        "1",
        "2",
        "3",
        "4",
        "5",
        "6",
        "7",
        "8",
        "9"
      ],
      "couponPattern": "SUMMER-####-####"
    },
    "referralSettings": {
      "validCharacters": [
        "A",
        "B",
        "C",
        "D",
        "E",
        "F",
        "G",
        "H",
        "I",
        "J",
        "K",
        "L",
        "M",
        "N",
        "O",
        "P",
        "Q",
        "R",
        "S",
        "T",
        "U",
        "V",
        "W",
        "X",
        "Y",
        "Z",
        "0",
        "1",
        "2",
        "3",
        "4",
        "5",
        "6",
        "7",
        "8",
        "9"
      ],
      "couponPattern": "SUMMER-####-####"
    },
    "limits": [
      {
        "action": "createCoupon",
        "limit": 1000,
        "period": "yearly",
        "entities": [
          "Coupon"
        ]
      }
    ],
    "campaignGroups": [
      1,
      3
    ],
    "type": "advanced",
    "linkedStoreIds": [
      1,
      2,
      3
    ],
    "budgets": [
      {
        "action": "createCoupon",
        "limit": 1000,
        "counter": 42
      }
    ],
    "couponRedemptionCount": 163,
    "referralRedemptionCount": 3,
    "discountCount": 288,
    "discountEffectCount": 343,
    "couponCreationCount": 16,
    "referralCreationCount": 8,
    "awardedGiveawaysCount": 9,
    "createdLoyaltyPointsCount": 9,
    "createdLoyaltyPointsEffectCount": 2,
    "redeemedLoyaltyPointsCount": 8,
    "redeemedLoyaltyPointsEffectCount": 9,
    "reservecouponEffectCount": 9,
    "lastActivity": "2022-11-10T23:00:00Z",
    "updated": "2022-10-27T15:00:00Z",
    "createdBy": "John Doe",
    "updatedBy": "Jane Doe",
    "templateId": 3,
    "frontendState": "running",
    "storesImported": true,
    "valueMapsIds": [
      100,
      215
    ],
    "experimentId": 1,
    "revisionFrontendState": "revised",
    "activeRevisionId": 6,
    "activeRevisionVersionId": 6,
    "version": 6,
    "currentRevisionId": 6,
    "currentRevisionVersionId": 6
  },
  "state": "enabled",
  "variants": [
    {
      "id": 6,
      "created": "2020-06-10T09:05:27.993483Z",
      "name": "Variant A",
      "experimentId": 10,
      "ruleset": {
        "id": 6,
        "created": "2020-06-10T09:05:27.993483Z",
        "userId": 388,
        "rules": [
          {
            "id": "7fa800a8-ac8d-4792-85dc-c4650dcc8f23",
            "parentId": "7fa800a8-ac8d-4792-85dc-c4650dcc8f23",
            "title": "Give discount via coupon",
            "description": "Creates a discount when a coupon is valid",
            "bindings": [
              {
                "name": "Discount percentage",
                "type": "templateParameter",
                "expression": [
                  "identity",
                  10
                ],
                "valueType": "number",
                "maxValue": 19.9,
                "attributeId": 100,
                "description": "The percentage discount applied to the cart total."
              }
            ],
            "condition": [
              "and",
              [
                "couponValid"
              ]
            ],
            "effects": [
              "catch",
              [
                "noop"
              ],
              [
                "setDiscount",
                "10% off",
                [
                  "*",
                  [
                    ".",
                    "Session",
                    "Total"
                  ],
                  [
                    "/",
                    10,
                    100
                  ]
                ]
              ]
            ]
          }
        ],
        "strikethroughRules": [
          {
            "id": "7fa800a8-ac8d-4792-85dc-c4650dcc8f23",
            "parentId": "7fa800a8-ac8d-4792-85dc-c4650dcc8f23",
            "title": "Give discount via coupon",
            "description": "Creates a discount when a coupon is valid",
            "bindings": [
              {
                "name": "Discount percentage",
                "type": "templateParameter",
                "expression": [
                  "identity",
                  10
                ],
                "valueType": "number",
                "maxValue": 19.9,
                "attributeId": 100,
                "description": "The percentage discount applied to the cart total."
              }
            ],
            "condition": [
              "and",
              [
                "couponValid"
              ]
            ],
            "effects": [
              "catch",
              [
                "noop"
              ],
              [
                "setDiscount",
                "10% off",
                [
                  "*",
                  [
                    ".",
                    "Session",
                    "Total"
                  ],
                  [
                    "/",
                    10,
                    100
                  ]
                ]
              ]
            ]
          }
        ],
        "bindings": [],
        "rbVersion": "v2",
        "activate": true,
        "campaignId": 320,
        "templateId": 3
      },
      "weight": 12,
      "isPrimary": true,
      "audienceId": 55
    }
  ],
  "goalDescription": "Offering free shipping will increase average order revenue more than a 10% discount"
}

Changes

  • 7ef1b9504c3aRevision changes
    • breaking

      the response property //// became optional for the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      response property allOf[subschema #3]/isVariantAssignmentExternal deprecated

    • info

      response property allOf[subschema #3]/variants/items/allOf[subschema #2]/isPrimary deprecated