Skip to main content

Analytics Endpoints

Analytics routes derive the merchant from the authenticated user/API key context and read from the analytics store. Use these endpoints for dashboard charts, payment audit, rule/volume decision inspection, and debit-routing audit. Every route on this page also requires x-tenant-id ($TENANT_HEADER — see Environment setup) in addition to $AUTH_HEADER. It has no fallback: omitting it fails with TE_03: x-tenant-id not found in headers even with a valid API key or JWT. This is the one header group most other Decision Engine routes (/decide-gateway, /routing/*, /merchant-account/*, etc.) don’t need. Common query parameters:

Overview

High-level dashboard summary for the selected merchant and time window.

Gateway Scores

Auth-rate score snapshots and connector success-rate trend.

Decisions

Decision volume by connector and routing approach.

Routing Stats

Connector share, rule hits, routing filter options, and chart data.

Log Summaries

Failure aggregates and recent error samples.

Payment Audit

Payment-level trail search. Prefer payment_id for exact lookup.

Preview Trace

Rule/volume decisions captured from /routing/evaluate. The transport route remains /analytics/preview-trace even when the UI labels these as decisions.

Debit Routing Audit

Cost Savings

Rollup of savings attributed to multi-objective routing — how much cheaper the chosen gateway was versus the plain SR head, trended over the window.
currency is optional — omit it to aggregate across all currencies present in the window.

Routing Events

Historical feed of routing-relevant state changes — SR leader changes, gateways entering/exiting the multi-objective auth band, and autopilot calibration runs. Powers the dashboard’s routing timeline and the simulation UI’s “Autopilot Actions” panel.
event_type is one of leader_changed, gateway_entered_auth_band, gateway_exited_auth_band, or calibration_applied (an autopilot re-tune — see Merchant Features). Auth-band events only fire when multi-objective routing is enabled for the merchant. Additional filters: min_transaction_count, min_score_delta, tolerance_pp (auth-band width override), limit.

A/B Test Experiment Results

Statistical significance results and the per-transaction log for a routing A/B test. Full reference, including the verdict enum and guardrail behavior: A/B Testing: Results.

Notes

  • Use range for preset windows and start_ms/end_ms for custom windows.
  • Use page and page_size on list-heavy views such as payment audit and preview trace.
  • Use exclude_routing_approach=NTW_BASED_ROUTING when auth-rate audit should hide debit-routing decisions.
  • Freshly inserted analytics events may take a short moment to appear because writes are asynchronous.