Fetch entity and global success rates
curl --request POST \
--url https://api.example.com/success_rate.SuccessRateCalculator/FetchEntityAndGlobalSuccessRate \
--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 '
{
"entity_id": "merchant1",
"entity_params": "card",
"entity_labels": [
"stripe",
"adyen"
],
"global_labels": [
"visa",
"mastercard"
],
"config": {
"entity_min_aggregates_size": 10,
"entity_default_success_rate": 0.85
}
}
'import requests
url = "https://api.example.com/success_rate.SuccessRateCalculator/FetchEntityAndGlobalSuccessRate"
payload = {
"entity_id": "merchant1",
"entity_params": "card",
"entity_labels": ["stripe", "adyen"],
"global_labels": ["visa", "mastercard"],
"config": {
"entity_min_aggregates_size": 10,
"entity_default_success_rate": 0.85
}
}
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({
entity_id: 'merchant1',
entity_params: 'card',
entity_labels: ['stripe', 'adyen'],
global_labels: ['visa', 'mastercard'],
config: {entity_min_aggregates_size: 10, entity_default_success_rate: 0.85}
})
};
fetch('https://api.example.com/success_rate.SuccessRateCalculator/FetchEntityAndGlobalSuccessRate', 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/FetchEntityAndGlobalSuccessRate",
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([
'entity_id' => 'merchant1',
'entity_params' => 'card',
'entity_labels' => [
'stripe',
'adyen'
],
'global_labels' => [
'visa',
'mastercard'
],
'config' => [
'entity_min_aggregates_size' => 10,
'entity_default_success_rate' => 0.85
]
]),
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/FetchEntityAndGlobalSuccessRate"
payload := strings.NewReader("{\n \"entity_id\": \"merchant1\",\n \"entity_params\": \"card\",\n \"entity_labels\": [\n \"stripe\",\n \"adyen\"\n ],\n \"global_labels\": [\n \"visa\",\n \"mastercard\"\n ],\n \"config\": {\n \"entity_min_aggregates_size\": 10,\n \"entity_default_success_rate\": 0.85\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/FetchEntityAndGlobalSuccessRate")
.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 \"entity_id\": \"merchant1\",\n \"entity_params\": \"card\",\n \"entity_labels\": [\n \"stripe\",\n \"adyen\"\n ],\n \"global_labels\": [\n \"visa\",\n \"mastercard\"\n ],\n \"config\": {\n \"entity_min_aggregates_size\": 10,\n \"entity_default_success_rate\": 0.85\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/success_rate.SuccessRateCalculator/FetchEntityAndGlobalSuccessRate")
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 \"entity_id\": \"merchant1\",\n \"entity_params\": \"card\",\n \"entity_labels\": [\n \"stripe\",\n \"adyen\"\n ],\n \"global_labels\": [\n \"visa\",\n \"mastercard\"\n ],\n \"config\": {\n \"entity_min_aggregates_size\": 10,\n \"entity_default_success_rate\": 0.85\n }\n}"
response = http.request(request)
puts response.read_body{
"entity_scores_with_labels": [
[
{
"score": 100,
"label": "stripe"
},
{
"score": 98.5,
"label": "adyen"
}
]
],
"global_scores_with_labels": [
[
{
"score": 100,
"label": "stripe"
},
{
"score": 98.5,
"label": "adyen"
}
]
]
}Success Rate
Fetch entity and global success rates
Calculates success rates for both entity-specific and global metrics
POST
/
success_rate.SuccessRateCalculator
/
FetchEntityAndGlobalSuccessRate
Fetch entity and global success rates
curl --request POST \
--url https://api.example.com/success_rate.SuccessRateCalculator/FetchEntityAndGlobalSuccessRate \
--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 '
{
"entity_id": "merchant1",
"entity_params": "card",
"entity_labels": [
"stripe",
"adyen"
],
"global_labels": [
"visa",
"mastercard"
],
"config": {
"entity_min_aggregates_size": 10,
"entity_default_success_rate": 0.85
}
}
'import requests
url = "https://api.example.com/success_rate.SuccessRateCalculator/FetchEntityAndGlobalSuccessRate"
payload = {
"entity_id": "merchant1",
"entity_params": "card",
"entity_labels": ["stripe", "adyen"],
"global_labels": ["visa", "mastercard"],
"config": {
"entity_min_aggregates_size": 10,
"entity_default_success_rate": 0.85
}
}
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({
entity_id: 'merchant1',
entity_params: 'card',
entity_labels: ['stripe', 'adyen'],
global_labels: ['visa', 'mastercard'],
config: {entity_min_aggregates_size: 10, entity_default_success_rate: 0.85}
})
};
fetch('https://api.example.com/success_rate.SuccessRateCalculator/FetchEntityAndGlobalSuccessRate', 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/FetchEntityAndGlobalSuccessRate",
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([
'entity_id' => 'merchant1',
'entity_params' => 'card',
'entity_labels' => [
'stripe',
'adyen'
],
'global_labels' => [
'visa',
'mastercard'
],
'config' => [
'entity_min_aggregates_size' => 10,
'entity_default_success_rate' => 0.85
]
]),
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/FetchEntityAndGlobalSuccessRate"
payload := strings.NewReader("{\n \"entity_id\": \"merchant1\",\n \"entity_params\": \"card\",\n \"entity_labels\": [\n \"stripe\",\n \"adyen\"\n ],\n \"global_labels\": [\n \"visa\",\n \"mastercard\"\n ],\n \"config\": {\n \"entity_min_aggregates_size\": 10,\n \"entity_default_success_rate\": 0.85\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/FetchEntityAndGlobalSuccessRate")
.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 \"entity_id\": \"merchant1\",\n \"entity_params\": \"card\",\n \"entity_labels\": [\n \"stripe\",\n \"adyen\"\n ],\n \"global_labels\": [\n \"visa\",\n \"mastercard\"\n ],\n \"config\": {\n \"entity_min_aggregates_size\": 10,\n \"entity_default_success_rate\": 0.85\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/success_rate.SuccessRateCalculator/FetchEntityAndGlobalSuccessRate")
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 \"entity_id\": \"merchant1\",\n \"entity_params\": \"card\",\n \"entity_labels\": [\n \"stripe\",\n \"adyen\"\n ],\n \"global_labels\": [\n \"visa\",\n \"mastercard\"\n ],\n \"config\": {\n \"entity_min_aggregates_size\": 10,\n \"entity_default_success_rate\": 0.85\n }\n}"
response = http.request(request)
puts response.read_body{
"entity_scores_with_labels": [
[
{
"score": 100,
"label": "stripe"
},
{
"score": 98.5,
"label": "adyen"
}
]
],
"global_scores_with_labels": [
[
{
"score": 100,
"label": "stripe"
},
{
"score": 98.5,
"label": "adyen"
}
]
]
}Body
application/json
Response
Success rates calculated successfully
Entity-specific labels with their calculated success rates
Show child attributes
Show child attributes
Example:
[
{ "score": 100, "label": "stripe" },
{ "score": 98.5, "label": "adyen" }
]
Global labels with their calculated success rates
Show child attributes
Show child attributes
Example:
[
{ "score": 100, "label": "stripe" },
{ "score": 98.5, "label": "adyen" }
]
⌘I