Fetch success rate for an entity

Calculates success rate for an entity based on provided parameters and labels

POST /success_rate.SuccessRateCalculator/FetchSuccessRate

Try it

Fetch success rate for an entity

cURL

curl --request POST \
  --url https://api.example.com/success_rate.SuccessRateCalculator/FetchSuccessRate \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --header 'x-profile-id: <x-profile-id>' \
  --header 'x-tenant-id: <x-tenant-id>' \
  --data '
{
  "id": "merchant1",
  "params": "card",
  "labels": [
    "stripe",
    "adyen"
  ],
  "config": {
    "min_aggregates_size": 10,
    "default_success_rate": 0.95,
    "specificity_level": "ENTITY"
  }
}
'

200

{
  "labels_with_score": [
    [
      {
        "score": 100,
        "label": "stripe"
      },
      {
        "score": 98.5,
        "label": "adyen"
      }
    ]
  ],
  "routing_approach": "EXPLOITATION"
}

Headers

x-tenant-id · string · required

x-profile-id · string · required

x-api-key · string · required

Body

application/json

id · string · required

Entity identifier

Example:

"merchant1"

params · string · required

Parameters on which success rate scores has to be maintained

Example:

"card"

labels · string[] · required

Labels for which to calculate success rates

Example:

["stripe", "adyen"]

config · object

Show child attributes

config. min_aggregates_size · integer<uint32> · required

Example:

10

config. default_success_rate · number<double> · required

Example:

0.95

config. specificity_level · enum<string>

Defines the specificity level to be used for calculating the success rate.

Available options: ENTITY, GLOBAL

Example:

"ENTITY"

Response

200

application/json

Success rate calculated successfully

labels_with_score · object[][]

List of labels with their calculated success rates

Show child attributes

labels_with_score. score · number<double> · required

Calculated success rate score

Example:

100

labels_with_score. label · string · required

Label identifier

Example:

"stripe"

Example:

[
  { "score": 100, "label": "stripe" },
  { "score": 98.5, "label": "adyen" }
]

routing_approach · enum<string>

Defines the routing approach based on the success rate calculation.

Available options: EXPLORATION, EXPLOITATION

Example:

"EXPLOITATION"