API Reference
Start typing to search…

Get Customer Analytics

get
https://api.prahsys.com/payments/n1/organization//analytics/customers
Path Params
string
required

The organization ID

Query Params
string

The period to calculate analytics for relative to the current time. Options: 1h, 24h, 7d, 30d, 3mo, 6mo, 1y

string
required

The interval size to calculate analytics for. Defaults to 'day'. Options: hour, day, week, month, year

string

The start time of the period to calculate analytics for (cannot be used in combination with forLast param). Example: ?periodStart=2025-05-29

string

The end time of the period to calculate analytics for (cannot be used in combination with forLast param). Example: ?periodEnd=2025-05-30

string
required

Filter the customer analytics by attribute(s).

Scopes:

Filter by specific conditions defined in the model.

NOTE: either merchantId or channelPartnerId must be provided in the query filters.

  • Allowed scopes: merchantId, channelPartnerId

  • Example: ?filter[merchantId]=123456

  • Example: ?filter[merchantId]=123456,789012 (multiple merchant IDs)

  • Example: ?filter[channelPartnerId]=123456

Headers
string
Response

Updated about 2 months ago

Language
Credentials
Bearer
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated about 2 months ago