GET
/
Statistic
/
customerbasic
/
{mode}
/
{freq}
/
{customerId}
curl --request GET \
  --url https://api-sandbox.payabli.com/api/Statistic/customerbasic/{mode}/{freq}/{customerId} \
  --header 'requestToken: <api-key>'
[
  {
    "interval": "<string>",
    "count": 123,
    "volume": 123
  }
]

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.

Example:

998

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.

Example:

"m"

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
Example:

"ytd"

Query Parameters

parameters
object

List of parameters.

Response

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

Was this page helpful?