Sign in

v1

latestOpenAPI 3.0.02026-07-26168846732.2 KB
Success Rate

Fetch success rate for an entity

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

post/success_rate.SuccessRateCalculator/FetchSuccessRate

Headers

x-tenant-idstring required
x-profile-idstring required
x-api-keystring required

Request body

idstring required

Entity identifier

paramsstring required

Parameters on which success rate scores has to be maintained

labelsstring[] required

Labels for which to calculate success rates

Example request

{
  "id": "merchant1",
  "params": "card",
  "labels": [
    "stripe",
    "adyen"
  ],
  "config": {
    "min_aggregates_size": 10,
    "default_success_rate": 0.95,
    "specificity_level": "ENTITY"
  }
}

Response

Success rate calculated successfully

routing_approach'EXPLORATION' | 'EXPLOITATION'

Defines the routing approach based on the success rate calculation.

Example response

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