Fetch success rate for an entity
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": 5,
"default_success_rate": 0.95,
"specificity_level": "ENTITY",
"exploration_percent": 20,
"shuffle_on_tie_during_exploitation": true
}
}
'import requests
url = "https://api.example.com/success_rate.SuccessRateCalculator/FetchSuccessRate"
payload = {
"id": "merchant1",
"params": "card",
"labels": ["stripe", "adyen"],
"config": {
"min_aggregates_size": 5,
"default_success_rate": 0.95,
"specificity_level": "ENTITY",
"exploration_percent": 20,
"shuffle_on_tie_during_exploitation": True
}
}
headers = {
"x-tenant-id": "<x-tenant-id>",
"x-profile-id": "<x-profile-id>",
"x-api-key": "<x-api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-tenant-id': '<x-tenant-id>',
'x-profile-id': '<x-profile-id>',
'x-api-key': '<x-api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
id: 'merchant1',
params: 'card',
labels: ['stripe', 'adyen'],
config: {
min_aggregates_size: 5,
default_success_rate: 0.95,
specificity_level: 'ENTITY',
exploration_percent: 20,
shuffle_on_tie_during_exploitation: true
}
})
};
fetch('https://api.example.com/success_rate.SuccessRateCalculator/FetchSuccessRate', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/success_rate.SuccessRateCalculator/FetchSuccessRate",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'id' => 'merchant1',
'params' => 'card',
'labels' => [
'stripe',
'adyen'
],
'config' => [
'min_aggregates_size' => 5,
'default_success_rate' => 0.95,
'specificity_level' => 'ENTITY',
'exploration_percent' => 20,
'shuffle_on_tie_during_exploitation' => true
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <x-api-key>",
"x-profile-id: <x-profile-id>",
"x-tenant-id: <x-tenant-id>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/success_rate.SuccessRateCalculator/FetchSuccessRate"
payload := strings.NewReader("{\n \"id\": \"merchant1\",\n \"params\": \"card\",\n \"labels\": [\n \"stripe\",\n \"adyen\"\n ],\n \"config\": {\n \"min_aggregates_size\": 5,\n \"default_success_rate\": 0.95,\n \"specificity_level\": \"ENTITY\",\n \"exploration_percent\": 20,\n \"shuffle_on_tie_during_exploitation\": true\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-tenant-id", "<x-tenant-id>")
req.Header.Add("x-profile-id", "<x-profile-id>")
req.Header.Add("x-api-key", "<x-api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/success_rate.SuccessRateCalculator/FetchSuccessRate")
.header("x-tenant-id", "<x-tenant-id>")
.header("x-profile-id", "<x-profile-id>")
.header("x-api-key", "<x-api-key>")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"merchant1\",\n \"params\": \"card\",\n \"labels\": [\n \"stripe\",\n \"adyen\"\n ],\n \"config\": {\n \"min_aggregates_size\": 5,\n \"default_success_rate\": 0.95,\n \"specificity_level\": \"ENTITY\",\n \"exploration_percent\": 20,\n \"shuffle_on_tie_during_exploitation\": true\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/success_rate.SuccessRateCalculator/FetchSuccessRate")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-tenant-id"] = '<x-tenant-id>'
request["x-profile-id"] = '<x-profile-id>'
request["x-api-key"] = '<x-api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"id\": \"merchant1\",\n \"params\": \"card\",\n \"labels\": [\n \"stripe\",\n \"adyen\"\n ],\n \"config\": {\n \"min_aggregates_size\": 5,\n \"default_success_rate\": 0.95,\n \"specificity_level\": \"ENTITY\",\n \"exploration_percent\": 20,\n \"shuffle_on_tie_during_exploitation\": true\n }\n}"
response = http.request(request)
puts response.read_body{
"labels_with_score": [
[
{
"score": 100,
"label": "stripe"
},
{
"score": 98.5,
"label": "adyen"
}
]
],
"routing_approach": "EXPLOITATION"
}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
Fetch success rate for an entity
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": 5,
"default_success_rate": 0.95,
"specificity_level": "ENTITY",
"exploration_percent": 20,
"shuffle_on_tie_during_exploitation": true
}
}
'import requests
url = "https://api.example.com/success_rate.SuccessRateCalculator/FetchSuccessRate"
payload = {
"id": "merchant1",
"params": "card",
"labels": ["stripe", "adyen"],
"config": {
"min_aggregates_size": 5,
"default_success_rate": 0.95,
"specificity_level": "ENTITY",
"exploration_percent": 20,
"shuffle_on_tie_during_exploitation": True
}
}
headers = {
"x-tenant-id": "<x-tenant-id>",
"x-profile-id": "<x-profile-id>",
"x-api-key": "<x-api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-tenant-id': '<x-tenant-id>',
'x-profile-id': '<x-profile-id>',
'x-api-key': '<x-api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
id: 'merchant1',
params: 'card',
labels: ['stripe', 'adyen'],
config: {
min_aggregates_size: 5,
default_success_rate: 0.95,
specificity_level: 'ENTITY',
exploration_percent: 20,
shuffle_on_tie_during_exploitation: true
}
})
};
fetch('https://api.example.com/success_rate.SuccessRateCalculator/FetchSuccessRate', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/success_rate.SuccessRateCalculator/FetchSuccessRate",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'id' => 'merchant1',
'params' => 'card',
'labels' => [
'stripe',
'adyen'
],
'config' => [
'min_aggregates_size' => 5,
'default_success_rate' => 0.95,
'specificity_level' => 'ENTITY',
'exploration_percent' => 20,
'shuffle_on_tie_during_exploitation' => true
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <x-api-key>",
"x-profile-id: <x-profile-id>",
"x-tenant-id: <x-tenant-id>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/success_rate.SuccessRateCalculator/FetchSuccessRate"
payload := strings.NewReader("{\n \"id\": \"merchant1\",\n \"params\": \"card\",\n \"labels\": [\n \"stripe\",\n \"adyen\"\n ],\n \"config\": {\n \"min_aggregates_size\": 5,\n \"default_success_rate\": 0.95,\n \"specificity_level\": \"ENTITY\",\n \"exploration_percent\": 20,\n \"shuffle_on_tie_during_exploitation\": true\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-tenant-id", "<x-tenant-id>")
req.Header.Add("x-profile-id", "<x-profile-id>")
req.Header.Add("x-api-key", "<x-api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/success_rate.SuccessRateCalculator/FetchSuccessRate")
.header("x-tenant-id", "<x-tenant-id>")
.header("x-profile-id", "<x-profile-id>")
.header("x-api-key", "<x-api-key>")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"merchant1\",\n \"params\": \"card\",\n \"labels\": [\n \"stripe\",\n \"adyen\"\n ],\n \"config\": {\n \"min_aggregates_size\": 5,\n \"default_success_rate\": 0.95,\n \"specificity_level\": \"ENTITY\",\n \"exploration_percent\": 20,\n \"shuffle_on_tie_during_exploitation\": true\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/success_rate.SuccessRateCalculator/FetchSuccessRate")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-tenant-id"] = '<x-tenant-id>'
request["x-profile-id"] = '<x-profile-id>'
request["x-api-key"] = '<x-api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"id\": \"merchant1\",\n \"params\": \"card\",\n \"labels\": [\n \"stripe\",\n \"adyen\"\n ],\n \"config\": {\n \"min_aggregates_size\": 5,\n \"default_success_rate\": 0.95,\n \"specificity_level\": \"ENTITY\",\n \"exploration_percent\": 20,\n \"shuffle_on_tie_during_exploitation\": true\n }\n}"
response = http.request(request)
puts response.read_body{
"labels_with_score": [
[
{
"score": 100,
"label": "stripe"
},
{
"score": 98.5,
"label": "adyen"
}
]
],
"routing_approach": "EXPLOITATION"
}Body
application/json
Response
Success rate calculated successfully
List of labels with their calculated success rates
Show child attributes
Show child attributes
Example:
[
{ "score": 100, "label": "stripe" },
{ "score": 98.5, "label": "adyen" }
]
Defines the routing approach based on the success rate calculation.
Available options:
EXPLORATION, EXPLOITATION Example:
"EXPLOITATION"
⌘I