Get stats for an org or paypoint

GET

/Statistic/basic/:mode/:freq/:level/:entryId

GET

/api/Statistic/basic/:mode/:freq/:level/:entryId

$ curl -G https://api-sandbox.payabli.com/api/Statistic/basic/ytd/m/1/1000000 \
>      -H "requestToken: <apiKey>" \
>      -d endDate=2023-05-23 \
>      -d startDate=2023-03-23

1 [
2   {
3     "additionalProperties": {
4       "key": "value"
5     },
6     "inACHReturns": 1,
7     "inACHReturnsVolume": 1.1,
8     "inACHTransactions": 1,
9     "inACHVolume": 1.1,
10     "inCardChargeBacks": 1,
11     "inCardChargeBackVolume": 1.1,
12     "inCardTransactions": 1,
13     "inCardVolume": 1.1,
14     "inCashTransactions": 1,
15     "inCashVolume": 1.1,
16     "inCheckTransactions": 1,
17     "inCheckVolume": 1.1,
18     "inCustomers": 1,
19     "inNewCustomers": 1,
20     "inSubscriptionsPaid": 1,
21     "inSubscriptionsPaidVolume": 1.1,
22     "inTransactions": 1,
23     "inTransactionsVolume": 1.1,
24     "outACHTransactions": 1,
25     "outACHVolume": 1.1,
26     "outCardTransactions": 1,
27     "outCardVolume": 1.1,
28     "outCheckTransactions": 1,
29     "outCheckVolume": 1.1,
30     "outCustomers": 1,
31     "outNewCustomers": 1,
32     "outSubscriptionsPaid": 1,
33     "outSubscriptionsPaidVolume": 1.1,
34     "outTransactions": 1,
35     "outTransactionsVolume": 1.1,
36     "outVCardTransactions": 1,
37     "outVCardVolume": 1.1,
38     "statX": "statX"
39   }
40 ]

Retrieves the basic statistics for an organization or a paypoint, for a given time period, grouped by a particular frequency.

Authentication

requestTokenstring

API Key authentication via header

Path parameters

entryIdlongRequired

Identifier in Payabli for the entity.

freqstringRequired

Frequency to group series. Allowed values:

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

For example, w groups the results by week.

Frequency to group series. Allowed values: - `m` - monthly - `w` - weekly - `d` - daily - `h` - hourly For example, `w` groups the results by week.

levelintegerRequired

The entry level for the request:

0 for Organization
2 for Paypoint

The entry level for the request: - 0 for Organization - 2 for Paypoint

modestringRequired

Mode for the request. Allowed values:

custom - Allows you to set a custom date range
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

Mode for the request. Allowed values: - `custom` - Allows you to set a custom date range - `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

endDatestringOptional

Used with custom mode. The end 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

parametersmap from strings to optional stringsOptional

List of parameters.

startDatestringOptional

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 start date for the range. Valid formats: - YYYY-mm-dd - YYYY/mm/dd - mm-dd-YYYY - mm/dd/YYYY

Response

Success

additionalPropertiesanyOptional

inACHReturnsintegerOptional

inACHReturnsVolumedoubleOptional

inACHTransactionsintegerOptional

inACHVolumedoubleOptional

inCardChargeBacksintegerOptional

inCardChargeBackVolumedoubleOptional

inCardTransactionsintegerOptional

inCardVolumedoubleOptional

inCashTransactionsintegerOptional

inCashVolumedoubleOptional

inCheckTransactionsintegerOptional

inCheckVolumedoubleOptional

inCustomersintegerOptional

inNewCustomersintegerOptional

inSubscriptionsPaidintegerOptional

inSubscriptionsPaidVolumedoubleOptional

inTransactionsintegerOptional

inTransactionsVolumedoubleOptional

outACHTransactionsintegerOptional

outACHVolumedoubleOptional

outCardTransactionsintegerOptional

outCardVolumedoubleOptional

outCheckTransactionsintegerOptional

outCheckVolumedoubleOptional

outCustomersintegerOptional

outNewCustomersintegerOptional

outSubscriptionsPaidintegerOptional

outSubscriptionsPaidVolumedoubleOptional

outTransactionsintegerOptional

outTransactionsVolumedoubleOptional

outVCardTransactionsintegerOptional

outVCardVolumedoubleOptional

statXstringOptional

Errors

400

Bad Request Error

401

Unauthorized Error

500

Internal Server Error

503

Service Unavailable Error