API - Deployment

Description

These APIs are used to get the deployment information of interactive channels.

Get Deployed Channel

This API call gets the currently active deployment information of an interactive channel.

GET/interact/v2/deployments/channels/{icIdOrName}

Parameters

Parameter	Description
icIdOrName	Interactive Channel ID or Name

Example Result

Content-Type: application/json

{
  "deployment": {
    "categoriesAndEvents": [
      {
        "categoryName": "string",
        "events": [
          {
            "eventActions": "string",
            "eventName": "string"
          }
        ]
      }
    ],
    "constraints": [
      {
        "constraintId": 0,
        "constraintName": "string",
        "offerConstraint": "string"
      }
    ],
    "flowcharts": [
      {
        "audienceLevel": "string",
        "flowchartName": "string"
      }
    ],
    "icName": "string",
    "lastDeploymentTime": "string",
    "offerThreshold": 0,
    "strategies": [
      {
        "ruleGroups": [
          {
            "cellCode": "string",
            "rules": [
              {
                "marketWeight": 0,
                "offerAttributes": [
                  "string"
                ],
                "offerCodes": "string",
                "offerName": "string",
                "predicate": "string",
                "predicateState": "string",
                "ruleEnabled": "string",
                "zoneName": "string"
              }
            ]
          }
        ],
        "stratergyName": "string"
      }
    ],
    "tableMapping": [
      {
        "audienceLevel": "string",
        "tableInfo": [
          {
            "parentTableName": "string",
            "preLoaded": true,
            "tableName": "string"
          }
        ]
      }
    ],
    "zonesAndInteractionPoints": [
      {
        "interactionPoints": [
          "string"
        ],
        "zoneName": "string"
      }
    ]
  }
}

Get Deployed Offers

This API call gets the deployment information of all currently deployed offers.

GET/interact/v2/deployments/offers

Example Result

Content-Type: application/json

{
  "offers": [
    {
      "constraintIds": [
        0
      ],
      "offerCode": [
        "string"
      ],
      "offerId": 0,
      "offerName": "offer",
      "suppressionRules": {
        "categoryName": "string",
        "eventType": "string",
        "hidden": true,
        "id": 0,
        "name": "string"
      }
    }
  ]
}