Analytics Overview

ClickHouse-backed overview read endpoint.

GET /analytics/overview

Overview

cURL

curl --request GET \
  --url http://localhost:8080/analytics/overview \
  --header 'Authorization: Bearer <token>' \
  --header 'x-tenant-id: <x-tenant-id>'

import requests

url = "http://localhost:8080/analytics/overview"

headers = {
    "x-tenant-id": "<x-tenant-id>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'x-tenant-id': '<x-tenant-id>', Authorization: 'Bearer <token>'}
};

fetch('http://localhost:8080/analytics/overview', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "8080",
  CURLOPT_URL => "http://localhost:8080/analytics/overview",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:8080/analytics/overview"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-tenant-id", "<x-tenant-id>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("http://localhost:8080/analytics/overview")
  .header("x-tenant-id", "<x-tenant-id>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://localhost:8080/analytics/overview")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["x-tenant-id"] = '<x-tenant-id>'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

{
  "merchant_id": "<string>",
  "kpis": [
    {
      "label": "<string>",
      "value": "<string>",
      "subtitle": "<string>"
    }
  ],
  "route_hits": [
    {
      "route": "<string>",
      "count": 123
    }
  ],
  "top_scores": [
    {
      "merchant_id": "<string>",
      "payment_method_type": "<string>",
      "payment_method": "<string>",
      "gateway": "<string>",
      "score_value": 123,
      "sigma_factor": 123,
      "average_latency": 123,
      "tp99_latency": 123,
      "transaction_count": 123,
      "last_updated_ms": 123
    }
  ],
  "top_errors": [
    {
      "route": "<string>",
      "error_code": "<string>",
      "error_message": "<string>",
      "count": 123,
      "last_seen_ms": 123
    }
  ],
  "top_rules": [
    {
      "rule_name": "<string>",
      "count": 123
    }
  ],
  "smart_retry_stats": {
    "retried_count": 123,
    "recovered_count": 123,
    "by_trigger": [
      {
        "gateway": "<string>",
        "error_code": "<string>",
        "count": 123
      }
    ],
    "by_fallback": [
      {
        "gateway": "<string>",
        "retried": 123,
        "recovered": 123
      }
    ]
  }
}

Authorizations

BearerAuthApiKeyAuth

Authorization · string · header · required

JWT token obtained from /auth/login

Headers

x-tenant-id · string · default: public · required

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

Query Parameters

range · string

start_ms · integer

end_ms · integer

page · integer

page_size · integer

payment_method_type · string

payment_method · string

card_network · string

card_is_in · string

currency · string

country · string

auth_type · string

gateway · string

payment_id · string

request_id · string

route · string

status · string

flow_type · string

routing_approach · string

exclude_routing_approach · string

error_code · string

merchant_id · string · required

Response

200 - application/json

OK

merchant_id · string

kpis · object[]

Show child attributes

route_hits · object[]

Show child attributes

top_scores · object[]

Show child attributes

top_errors · object[]

Show child attributes

top_rules · object[]

Show child attributes

smart_retry_stats · object

Show child attributes