Statistic
Get Statistics for Paypoint or Organization
Retrieves the basic statistics for an organization or a paypoint, for a given time period, grouped by a particular frequency.
GET
Authorizations
Most endpoints require an organization
token. Some endpoints require an application
token, and those endpoints are noted.
Path Parameters
Frequency to group series. Allowed values:
m
- monthlyw
- weeklyd
- dailyh
- hourly
For example, w
groups the results by week.
Mode for the request. Allowed values:
custom
- Allows you to set a custom date rangeytd
- Year To Datemtd
- Month To Datewtd
- Week To Datetoday
- All current daym12
- Last 12 monthsd30
- Last 30 daysh24
- Last 24 hourslasty
- Last Yearlastm
- Last Monthlastw
- Last Weekyesterday
- Last Day
The entry level for the request:
- 0 for Organization
- 2 for Paypoint
Identifier in Payabli for the entity.
Query Parameters
List of parameters.
Used with custom
mode. The start date for the range.
Valid formats:
- YYYY-mm-dd
- YYYY/mm/dd
- mm-dd-YYYY
- mm/dd/YYYY
Used with custom
mode. The end date for the range.
Valid formats:
- YYYY-mm-dd
- YYYY/mm/dd
- mm-dd-YYYY
- mm/dd/YYYY
Response
200 - application/json
The response is of type any[]
.
Was this page helpful?