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

Authorizations

requestToken
string
header
required

Most endpoints require an organization token. Some endpoints require an application token, and those endpoints are noted.

Path Parameters

customerId
integer
required

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

freq
string
required

Frequency to group series. Allowed values:

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

For example, w groups the results by week.

mode
string
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

Query Parameters

parameters
object

List of parameters.

Response

200 - application/json
count
integer
interval
string | null
volume
number