TAtalon
Campaigns

List campaign rulesets

[!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.

List all rulesets of this campaign. A ruleset is a revision of the rules of a campaign. Important: The response also includes deleted rules. You should only consider the latest revision of the returned rulesets.

get/v1/applications/{applicationId}/campaigns/{campaignId}/rulesets

Request

Path parameters

applicationIdinteger required

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

campaignIdinteger required

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

Query parameters

pageSizeinteger

The number of items in the response.

skipinteger

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

OK

totalResultSizeinteger required

Example response

{
  "totalResultSize": 1,
  "data": [
    {
      "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
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.