Rule Configuration

Create rule config

Changed on

Create a service-level configuration for successRate or elimination scoring. Controls the time window, minimum data thresholds, and other parameters used in SR computation.

post/rule/create

Request

  • Base URL
    http://localhost:8080
  • URL
    http://localhost:8080/rule/create
  • Auth
    • HTTP bearer
    • or API key in header x-api-key

Request body

merchant_idstring required

Example request

{
  "merchant_id": "merchant_demo",
  "config": {
    "type": "successRate",
    "data": {
      "defaultBucketSize": 20,
      "subLevelInputConfig": [
        {
          "paymentMethod": "CARD",
          "paymentMethodType": "CREDIT",
          "bucketSize": 30,
          "hedgingPercent": 0.05
        }
      ],
      "margin": 0.2
    }
  }
}

Response

Rule config created

messagestring
merchant_idstring

Example response

{
  "message": "Success Rate Configuration created successfully",
  "merchant_id": "merchant_demo",
  "config": {
    "type": "successRate",
    "data": {
      "defaultBucketSize": 20,
      "subLevelInputConfig": [
        {
          "paymentMethod": "CARD",
          "paymentMethodType": "CREDIT",
          "bucketSize": 30,
          "hedgingPercent": 0.05
        }
      ],
      "margin": 0.2
    }
  }
}

Changes

    • breaking

      the request property //////// became not nullable

    • breaking

      the request property //////// became required

    • info

      the response property //////// became required for the status

    • breaking

      added the new required request property /

    • breaking

      added the new required request property /

    • info

      added the optional property to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status