GET
/
Statistic
/
basic
/
{mode}
/
{freq}
/
{level}
/
{entryId}

Authorizations

requestToken
string
header
required

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

Path Parameters

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 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
level
integer
required

The entry level for the request:

  • 0 for Organization
  • 2 for Paypoint
entryId
integer
required

Identifier in Payabli for the entity.

Query Parameters

parameters
object

List of parameters.

startDate
string

Used with custom mode. The start date for the range. Valid formats:

  • YYYY-mm-dd
  • YYYY/mm/dd
  • mm-dd-YYYY
  • mm/dd/YYYY
endDate
string

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[].