JUjuspay
Analytics

Cost savings

Changed on

ClickHouse-backed rollup of savings attributed to multi-objective (cost-aware) routing, trended over the window.

get/analytics/cost-savings

Request

  • Base URL
    http://localhost:8080
  • URL
    http://localhost:8080/analytics/cost-savings
  • Auth
    • HTTP bearer
    • or API key in header x-api-key

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

Cost savings

merchant_idstring
rangestring
currencystring nullable

Example response

{
  "merchant_id": "merchant_demo",
  "range": "1d",
  "currency": "USD",
  "available_currencies": [
    {
      "currency": "USD"
    }
  ],
  "trend": [
    {
      "bucket_ms": 1808624000000
    }
  ]
}

Changes

  • 36e7a0972ee6Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 6ee57fb4b22bRevision changes
    • info

      endpoint added