Get Customer list in Company

post

https://api.embermind.ch/api/v1/client/customers/get-list

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

page

number

> 0

Page number (starts from 1)

perPage

number

0 to 500

Number of items per page (default 25, max 500)

usePeriodMode

boolean

If true, use ClickHouse period-based mode (max 3 months). If false or undefined, use ClickHouse all-time mode (no date range, reads customer_daily_metrics_agg without an agg_date filter) (AD-2787).

sortBy

string

enum

required

sortDirection

string

enum

required

Allowed:

dateStart

date-time

required

dateEnd

date-time

required

searchValue

string

merchantIdList

array of uuids

merchantIdList

countryCodeList

array of strings

Card-issuer countries (transaction_card_country), the same notion of "country" the country pages use. A customer matches when at least one of their transactions inside the selected period was made with a card issued in one of these countries; the returned metrics are still the customer totals for the period, unchanged. Pass N_A for transactions with an unknown issuer country (EMB-2602 / EMB-2603).

countryCodeList

paymentTransactionCountMin

number

paymentTransactionCountMax

number

withdrawTransactionCountMin

number

withdrawTransactionCountMax

number

transactionCountMin

number

transactionCountMax

number

isHighEmptyTraffic

boolean

High empty traffic toggle: when true, entities with a transaction count below the company-level Empty Traffic Threshold are hidden for the selected period. When false or omitted, no filtering is applied.

paymentTransactionAmountMin

number

In major units, no minors

paymentTransactionAmountMax

number

In major units, no minors

withdrawTransactionAmountMin

number

In major units, no minors

withdrawTransactionAmountMax

number

In major units, no minors

transactionAmountMin

number

In major units, no minors

transactionAmountMax

number

In major units, no minors

cardTokenCountMin

number

cardTokenCountMax

number

transactionsAcceptCountMin

number

transactionsAcceptCountMax

number

transactionsDeclineCountMin

number

transactionsDeclineCountMax

number

transactionAmountAcceptMin

number

In major units, no minors

transactionAmountAcceptMax

number

In major units, no minors

transactionAmountDeclineMin

number

In major units, no minors

transactionAmountDeclineMax

number

In major units, no minors

conversionMin

number

conversionMax

number

feePercentMin

number

feePercentMax

number

withdrawalCountMin

number

withdrawalCountMax

number

depositCountMin

number

depositCountMax

number

Headers

x-access-token

string

x-api-key

string

Responses

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Response

400Response

500Response