Fetch entity and global success rates

Calculates success rates for both entity-specific and global metrics

POST /success_rate.SuccessRateCalculator/FetchEntityAndGlobalSuccessRate

Try it

Fetch entity and global success rates

cURL

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
  }
}
'

200

{
  "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"
      }
    ]
  ]
}

Headers

x-tenant-id · string · required

x-profile-id · string · required

x-api-key · string · required

Body

application/json

entity_id · string

Example:

"merchant1"

entity_params · string

Example:

"card"

entity_labels · string[]

Example:

["stripe", "adyen"]

global_labels · string[]

Example:

["visa", "mastercard"]

config · object

Show child attributes

config. entity_min_aggregates_size · integer<uint32>

Example:

10

config. entity_default_success_rate · number<double>

Example:

0.85

Example:

{
  "entity_min_aggregates_size": 10,
  "entity_default_success_rate": 0.85
}

Response

200

application/json

Success rates calculated successfully

entity_scores_with_labels · object[][]

Entity-specific labels with their calculated success rates

Show child attributes

entity_scores_with_labels. score · number<double> · required

Calculated success rate score

Example:

100

entity_scores_with_labels. label · string · required

Label identifier

Example:

"stripe"

Example:

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

global_scores_with_labels · object[][]

Global labels with their calculated success rates

Show child attributes

global_scores_with_labels. score · number<double> · required

Calculated success rate score

Example:

100

global_scores_with_labels. label · string · required

Label identifier

Example:

"stripe"

Example:

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