Statistic

Get basic statistics for a customer

Retrieves the basic statistics for a customer over a date range, grouped by a frequency. This is a Pay In view: it counts the customer's approved transactions and returns one row per time bucket. Volume here is the gross amount, before fees.

get/Statistic/customerbasic/{mode}/{freq}/{customerId}

Request

  • Base URL: https://api-sandbox.payabli.com/api
  • URL: https://api-sandbox.payabli.com/api/Statistic/customerbasic/{mode}/{freq}/{customerId}
  • Auth: HTTP bearer

Path parameters

customerIdinteger required

Payabli-generated customer ID. Maps to "Customer ID" column in the Payabli Portal.

freqstring required

Frequency to group series. Allowed values:

  • m - monthly
  • w - weekly
  • d - daily
  • h - hourly

For example, w groups the results by week.

modestring required

Mode for request. Allowed values:

  • ytd - Year To Date
  • mtd - Month To Date
  • wtd - Week To Date
  • today - All current day
  • m12 - Last 12 months
  • d30 - Last 30 days
  • h24 - Last 24 hours
  • lasty - Last Year
  • lastm - Last Month
  • lastw - Last Week
  • yesterday - Last Day

Response

Success

statXstring required

The time bucket for this row, formatted according to the query's freq (for example, 2026-9 for a monthly bucket). The response returns one object per bucket across the requested range.

inTransactionsinteger required

Count of the customer's approved transactions.

inTransactionsVolumenumber double required

Total gross value of the customer's approved transactions. Unlike /Statistic/basic, this volume is the gross amount, before fees.

Changes

No recorded changes to this operation across all 1 revision of this API.