List Experiments

List experiments
GET/v1/applications/{applicationId}/experiments
Use it in a workflow

Add a step and choose the Talon.One connector.
Pick the List Experiments action (under management).
Fill in the fields below, then reference the result from later steps as {{listExperiments.response.data}}.
Request

Path parameters

applicationIdinteger (int64)required
The ID of the Application. It is displayed in your Talon.One deployment URL.
Query parameters

pageSizeinteger (int64)
The number of items in the response.
Default 1000
skipinteger (int64)
The number of items to skip when paging through large result sets.
sortstring
The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
Response

Returns 200 with an object. Read it in later steps with {{listExperiments.response.data.<field>}}.
totalResultSizeinteger (int64)
dataarray<object>
idinteger (int64)required
The internal ID of this entity.
createdstring (date-time)required
The time this entity was created.
applicationIdinteger (int64)required
The ID of the Application that owns this entity.
isVariantAssignmentExternalboolean
The source of the assignment. - false - The variant assignment is handled internally by Talon.One. - true - The variant assignment is handled externally.
campaignobject40 fields
activatedstring (date-time)
The date and time the experiment was activated.
statestringrequired
A disabled experiment is not evaluated for rules or coupons.
One ofenableddisabledarchivedDefault "disabled"
variantsarray<object>7 fields
deletedatstring (date-time)
The date and time the experiment was deleted.
json
{
  "totalResultSize": 1,
  "data": [
    {
      "deletedat": {},
      "created": {},
      "campaign": {
        "type": "advanced",
        "templateId": 3,
        "customEffectCount": 0,
        "activeRevisionId": 6,
        "features": [
          "coupons",
          "referrals"
        ],
        "createdLoyaltyPointsCount": 9,
        "storesImported": true,
        "couponSettings": {
          "couponPattern": "SUMMER-####-####",
          "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"
          ]
        },
        "experimentId": 1,
        "id": 4,
        "state": "enabled",
        "couponAttributes": "{}",
        "reservecouponEffectCount": 9,
        "updatedBy": "Jane Doe",
        "frontendState": "running",
        "created": {},
        "referralCreationCount": 8,
        "stageRevision": false,
        "couponRedemptionCount": 163,
        "couponCreationCount": 16,
        "version": 6,
        "campaignGroups": [
          1,
          3
        ],
        "tags": [
          "summer"
        ],
        "discountEffectCount": 343,
        "budgets": [
          {
            "limit": 1000,
            "action": "createCoupon",
            "counter": 42
          },
          {
            "limit": 1000,
            "action": "createCoupon",
            "counter": 42
          }
        ],
        "redeemedLoyaltyPointsCount": 8,
        "name": "Summer promotions",
        "valueMapsIds": [
          100,
          215
        ],
        "applicationId": 322,
        "updated": {},
        "callApiEffectCount": 0,
        "createdLoyaltyPointsEffectCount": 2,
        "discountCount": 288,
        "revisionFrontendState": "revised",
        "description": "Campaign for all summer 2021 promotions",
        "activeRevisionVersionId": 6,
        "currentRevisionVersionId": 6,
        "startTime": {},
        "currentRevisionId": 6,
        "limits": [
          {
            "period": "yearly",
            "entities": [
              "Coupon"
            ],
            "limit": 1000,
            "action": "createCoupon"
          },
          {
            "period": "yearly",
            "entities": [
              "Coupon"
            ],
            "limit": 1000,
            "action": "createCoupon"
          }
        ],
        "activeRulesetId": 6,
        "reevaluateOnReturn": true,
        "userId": 388,
        "awardedGiveawaysCount": 9,
        "redeemedLoyaltyPointsEffectCount": 9,
        "linkedStoreIds": [
          1,
          2,
          3
        ],
        "createdBy": "John Doe",
        "addFreeItemEffectCount": 0,
        "referralSettings": {
          "couponPattern": "SUMMER-####-####",
          "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"
          ]
        },
        "attributes": "{}",
        "lastActivity": {},
        "endTime": {},
        "referralRedemptionCount": 3
      },
      "id": 6,
      "state": "enabled",
      "variants": [
        {
          "created": {},
          "isPrimary": true,
          "name": "Variant A",
          "ruleset": {
            "rbVersion": "v2",
            "created": {},
            "campaignId": 320,
            "bindings": [],
            "activatedAt": {},
            "activate": true,
            "rules": [
              {
                "condition": [
                  "and",
                  [
                    "couponValid"
                  ]
                ],
                "effects": [
                  "catch",
                  [
                    "noop"
                  ],
                  [
                    "setDiscount",
                    "10% off",
                    [
                      "*",
                      [
                        ".",
                        "Session",
                        "Total"
                      ],
                      [
                        "/",
                        10,
                        100
                      ]
                    ]
                  ]
                ],
                "bindings": [
                  {
                    "attributeId": 100,
                    "minValue": 0,
                    "expression": [
                      "string1",
                      "string2"
                    ],
                    "maxValue": 19.9,
                    "valueType": "string",
                    "name": "my property",
                    "description": "This is a template parameter of type `number`.",
                    "type": "templateParameter"
                  },
                  {
                    "attributeId": 100,
                    "minValue": 0,
                    "expression": [
                      "string1",
                      "string2"
                    ],
                    "maxValue": 19.9,
                    "valueType": "string",
                    "name": "my property",
                    "description": "This is a template parameter of type `number`.",
                    "type": "templateParameter"
                  }
                ],
                "description": "Creates a discount when a coupon is valid",
                "id": "7fa800a8-ac8d-4792-85dc-c4650dcc8f23",
                "title": "Give discount via coupon",
                "parentId": "7fa800a8-ac8d-4792-85dc-c4650dcc8f23"
              },
              {
                "condition": [
                  "and",
                  [
                    "couponValid"
                  ]
                ],
                "effects": [
                  "catch",
                  [
                    "noop"
                  ],
                  [
                    "setDiscount",
                    "10% off",
                    [
                      "*",
                      [
                        ".",
                        "Session",
                        "Total"
                      ],
                      [
                        "/",
                        10,
                        100
                      ]
                    ]
                  ]
                ],
                "bindings": [
                  {
                    "attributeId": 100,
                    "minValue": 0,
                    "expression": [
                      "string1",
                      "string2"
                    ],
                    "maxValue": 19.9,
                    "valueType": "string",
                    "name": "my property",
                    "description": "This is a template parameter of type `number`.",
                    "type": "templateParameter"
                  },
                  {
                    "attributeId": 100,
                    "minValue": 0,
                    "expression": [
                      "string1",
                      "string2"
                    ],
                    "maxValue": 19.9,
                    "valueType": "string",
                    "name": "my property",
                    "description": "This is a template parameter of type `number`.",
                    "type": "templateParameter"
                  }
                ],
                "description": "Creates a discount when a coupon is valid",
                "id": "7fa800a8-ac8d-4792-85dc-c4650dcc8f23",
                "title": "Give discount via coupon",
                "parentId": "7fa800a8-ac8d-4792-85dc-c4650dcc8f23"
              }
            ],
            "id": 6,
            "strikethroughRules": [
              {
                "condition": [
                  "and",
                  [
                    "couponValid"
                  ]
                ],
                "effects": [
                  "catch",
                  [
                    "noop"
                  ],
                  [
                    "setDiscount",
                    "10% off",
                    [
                      "*",
                      [
                        ".",
                        "Session",
                        "Total"
                      ],
                      [
                        "/",
                        10,
                        100
                      ]
                    ]
                  ]
                ],
                "bindings": [
                  {
                    "attributeId": 100,
                    "minValue": 0,
                    "expression": [
                      "string1",
                      "string2"
                    ],
                    "maxValue": 19.9,
                    "valueType": "string",
                    "name": "my property",
                    "description": "This is a template parameter of type `number`.",
                    "type": "templateParameter"
                  },
                  {
                    "attributeId": 100,
                    "minValue": 0,
                    "expression": [
                      "string1",
                      "string2"
                    ],
                    "maxValue": 19.9,
                    "valueType": "string",
                    "name": "my property",
                    "description": "This is a template parameter of type `number`.",
                    "type": "templateParameter"
                  }
                ],
                "description": "Creates a discount when a coupon is valid",
                "id": "7fa800a8-ac8d-4792-85dc-c4650dcc8f23",
                "title": "Give discount via coupon",
                "parentId": "7fa800a8-ac8d-4792-85dc-c4650dcc8f23"
              },
              {
                "condition": [
                  "and",
                  [
                    "couponValid"
                  ]
                ],
                "effects": [
                  "catch",
                  [
                    "noop"
                  ],
                  [
                    "setDiscount",
                    "10% off",
                    [
                      "*",
                      [
                        ".",
                        "Session",
                        "Total"
                      ],
                      [
                        "/",
                        10,
                        100
                      ]
                    ]
                  ]
                ],
                "bindings": [
                  {
                    "attributeId": 100,
                    "minValue": 0,
                    "expression": [
                      "string1",
                      "string2"
                    ],
                    "maxValue": 19.9,
                    "valueType": "string",
                    "name": "my property",
                    "description": "This is a template parameter of type `number`.",
                    "type": "templateParameter"
                  },
                  {
                    "attributeId": 100,
                    "minValue": 0,
                    "expression": [
                      "string1",
                      "string2"
                    ],
                    "maxValue": 19.9,
                    "valueType": "string",
                    "name": "my property",
                    "description": "This is a template parameter of type `number`.",
                    "type": "templateParameter"
                  }
                ],
                "description": "Creates a discount when a coupon is valid",
                "id": "7fa800a8-ac8d-4792-85dc-c4650dcc8f23",
                "title": "Give discount via coupon",
                "parentId": "7fa800a8-ac8d-4792-85dc-c4650dcc8f23"
              }
            ],
            "templateId": 3,
            "userId": 388
          },
          "weight": 12,
          "experimentId": 10,
          "id": 6
        },
        {
          "created": {},
          "isPrimary": true,
          "name": "Variant A",
          "ruleset": {
            "rbVersion": "v2",
            "created": {},
            "campaignId": 320,
            "bindings": [],
            "activatedAt": {},
            "activate": true,
            "rules": [
              {
                "condition": [
                  "and",
                  [
                    "couponValid"
                  ]
                ],
                "effects": [
                  "catch",
                  [
                    "noop"
                  ],
                  [
                    "setDiscount",
                    "10% off",
                    [
                      "*",
                      [
                        ".",
                        "Session",
                        "Total"
                      ],
                      [
                        "/",
                        10,
                        100
                      ]
                    ]
                  ]
                ],
                "bindings": [
                  {
                    "attributeId": 100,
                    "minValue": 0,
                    "expression": [
                      "string1",
                      "string2"
                    ],
                    "maxValue": 19.9,
                    "valueType": "string",
                    "name": "my property",
                    "description": "This is a template parameter of type `number`.",
                    "type": "templateParameter"
                  },
                  {
                    "attributeId": 100,
                    "minValue": 0,
                    "expression": [
                      "string1",
                      "string2"
                    ],
                    "maxValue": 19.9,
                    "valueType": "string",
                    "name": "my property",
                    "description": "This is a template parameter of type `number`.",
                    "type": "templateParameter"
                  }
                ],
                "description": "Creates a discount when a coupon is valid",
                "id": "7fa800a8-ac8d-4792-85dc-c4650dcc8f23",
                "title": "Give discount via coupon",
                "parentId": "7fa800a8-ac8d-4792-85dc-c4650dcc8f23"
              },
              {
                "condition": [
                  "and",
                  [
                    "couponValid"
                  ]
                ],
                "effects": [
                  "catch",
                  [
                    "noop"
                  ],
                  [
                    "setDiscount",
                    "10% off",
                    [
                      "*",
                      [
                        ".",
                        "Session",
                        "Total"
                      ],
                      [
                        "/",
                        10,
                        100
                      ]
                    ]
                  ]
                ],
                "bindings": [
                  {
                    "attributeId": 100,
                    "minValue": 0,
                    "expression": [
                      "string1",
                      "string2"
                    ],
                    "maxValue": 19.9,
                    "valueType": "string",
                    "name": "my property",
                    "description": "This is a template parameter of type `number`.",
                    "type": "templateParameter"
                  },
                  {
                    "attributeId": 100,
                    "minValue": 0,
                    "expression": [
                      "string1",
                      "string2"
                    ],
                    "maxValue": 19.9,
                    "valueType": "string",
                    "name": "my property",
                    "description": "This is a template parameter of type `number`.",
                    "type": "templateParameter"
                  }
                ],
                "description": "Creates a discount when a coupon is valid",
                "id": "7fa800a8-ac8d-4792-85dc-c4650dcc8f23",
                "title": "Give discount via coupon",
                "parentId": "7fa800a8-ac8d-4792-85dc-c4650dcc8f23"
              }
            ],
            "id": 6,
            "strikethroughRules": [
              {
                "condition": [
                  "and",
                  [
                    "couponValid"
                  ]
                ],
                "effects": [
                  "catch",
                  [
                    "noop"
                  ],
                  [
                    "setDiscount",
                    "10% off",
                    [
                      "*",
                      [
                        ".",
                        "Session",
                        "Total"
                      ],
                      [
                        "/",
                        10,
                        100
                      ]
                    ]
                  ]
                ],
                "bindings": [
                  {
                    "attributeId": 100,
                    "minValue": 0,
                    "expression": [
                      "string1",
                      "string2"
                    ],
                    "maxValue": 19.9,
                    "valueType": "string",
                    "name": "my property",
                    "description": "This is a template parameter of type `number`.",
                    "type": "templateParameter"
                  },
                  {
                    "attributeId": 100,
                    "minValue": 0,
                    "expression": [
                      "string1",
                      "string2"
                    ],
                    "maxValue": 19.9,
                    "valueType": "string",
                    "name": "my property",
                    "description": "This is a template parameter of type `number`.",
                    "type": "templateParameter"
                  }
                ],
                "description": "Creates a discount when a coupon is valid",
                "id": "7fa800a8-ac8d-4792-85dc-c4650dcc8f23",
                "title": "Give discount via coupon",
                "parentId": "7fa800a8-ac8d-4792-85dc-c4650dcc8f23"
              },
              {
                "condition": [
                  "and",
                  [
                    "couponValid"
                  ]
                ],
                "effects": [
                  "catch",
                  [
                    "noop"
                  ],
                  [
                    "setDiscount",
                    "10% off",
                    [
                      "*",
                      [
                        ".",
                        "Session",
                        "Total"
                      ],
                      [
                        "/",
                        10,
                        100
                      ]
                    ]
                  ]
                ],
                "bindings": [
                  {
                    "attributeId": 100,
                    "minValue": 0,
                    "expression": [
                      "string1",
                      "string2"
                    ],
                    "maxValue": 19.9,
                    "valueType": "string",
                    "name": "my property",
                    "description": "This is a template parameter of type `number`.",
                    "type": "templateParameter"
                  },
                  {
                    "attributeId": 100,
                    "minValue": 0,
                    "expression": [
                      "string1",
                      "string2"
                    ],
                    "maxValue": 19.9,
                    "valueType": "string",
                    "name": "my property",
                    "description": "This is a template parameter of type `number`.",
                    "type": "templateParameter"
                  }
                ],
                "description": "Creates a discount when a coupon is valid",
                "id": "7fa800a8-ac8d-4792-85dc-c4650dcc8f23",
                "title": "Give discount via coupon",
                "parentId": "7fa800a8-ac8d-4792-85dc-c4650dcc8f23"
              }
            ],
            "templateId": 3,
            "userId": 388
          },
          "weight": 12,
          "experimentId": 10,
          "id": 6
        }
      ],
      "applicationId": 322,
      "isVariantAssignmentExternal": true,
      "activated": {}
    }
  ]
}
Need more? See the Talon.One guide for connection setup and behaviour shared by every action.
Was this page helpful?