v12

latestOpenAPI 3.1.0AGPL-3.0raw.githubusercontent.com2026-08-0464108237.1 KB
Analytics

Overview

ClickHouse-backed overview read endpoint.

get/analytics/overview

Query parameters

rangestring
start_msinteger
end_msinteger
pageinteger
page_sizeinteger
payment_method_typestring
payment_methodstring
card_networkstring
card_is_instring
currencystring
countrystring
auth_typestring
gatewaystring
payment_idstring
request_idstring
routestring
statusstring
flow_typestring
routing_approachstring
exclude_routing_approachstring
error_codestring

Headers

x-tenant-idstring required

Tenant to resolve. The shipped config files define only the "public" tenant. No fallback — omitting this fails with TE_03.

Response

Overview

merchant_idstring

Example response

{
  "merchant_id": "merchant_demo",
  "kpis": [
    {
      "label": "Decision events / 1d",
      "value": "42"
    }
  ],
  "route_hits": [
    {
      "route": "decide_gateway",
      "count": 42
    }
  ],
  "top_scores": [
    {
      "payment_method_type": "CARD",
      "payment_method": "CREDIT",
      "gateway": "adyen",
      "score_value": 0.831,
      "transaction_count": 214,
      "last_updated_ms": 1808624000000
    }
  ],
  "top_errors": [
    {
      "route": "decide_gateway",
      "error_code": "processor_declined",
      "error_message": "Card declined by issuer",
      "count": 3,
      "last_seen_ms": 1808624000000
    }
  ],
  "top_rules": [
    {
      "rule_name": "priority rule",
      "count": 12
    }
  ],
  "smart_retry_stats": {
    "retried_count": 8,
    "recovered_count": 5
  }
}