Skip to navigation
API referencePay In endpointsCustomer

Get customer stats

Retrieves the basic statistics for a customer for a specific time period, grouped by a selected frequency.

Authentication

requestTokenstring
API Key authentication via header

Path parameters

customerIdintegerRequired

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

freqstringRequired

Frequency to group series. Allowed values:

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

For example, w groups the results by week.

modestringRequired

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

Query parameters

parametersmap from strings to optional stringsOptional
List of parameters.

Response

Success
countintegerOptional
intervalstringOptional
volumedoubleOptional

Errors

400
Bad Request Error
401
Unauthorized Error
500
Internal Server Error
503
Service Unavailable Error