Consumer Segmentation

Version: 1.0.0

Contact information:
API Support
datasuite@nexigroup.com

/consumerSegmentation/recurringCustomers

GET

Summary

Recurring Customers

Description

A detailed view of recurring customers based on the number of times they visit your locations.


Would you like to measure the effect of your campaigns in terms of generating more recurring customers?

Have you ever wondered if a new or current loyalty program is worth the effort?

Would you like to be proactive in avoiding churn among your most loyal customers?

If so, then this feature is for you. You can find out how many customers have been in your shop before and see the corresponding revenue from these loyal customers to quantify their value.

Parameters
Name Located in Description Required Schema
business_private query Filter transactions by business (0 = business) and private (1 = private). No integer
currency query Set ISO-4217 currency code. Default currency code = EUR). Example: DKK No string
date_range_end query End date in a range of dates Minimum value: 1 January four years ago Maximum value: Current date Example: YYYY-MM-DD Yes date
date_range_start query Initial date in a range of dates Minimum value: 1 January four years ago Maximum value: Current date Example: YYYY-MM-DD Yes date
domestic_international query Filter cardholder transactions by domestic (0 = domestic) or international (1 = international). No integer
estimated_residence_country_a3 query Filter by cardholder ISO-A3 country code. Example: DNK No [ string ]
estimated_residence_municipality_code query Filter by customer municipality code. Example: 43 No [ integer ]
estimated_residence_region_code query Filter by cardholder region. Example: 3 No [ integer ]
group_by query Group output by one or more of the following values. Possible values: transaction_year, transaction_quarter, transaction_month, transaction_week, transaction_date, transaction_day, group_name, company_name, vat_code, outlet_country, outlet_region, outlet_municipality, outlet_zipcode, outlet_id, outlet_name, outlet_mcc, online_physical, issuer_country, domestic_international, estimated_residence_municipality, estimated_residence_region, estimated_residence_country, is_municipality_local, is_regional_local, business_private. No [ string ]
is_municipality_local query Filter transactions by the cardholder estimated residence being either in the merchant municipality (1) or outside the merchant municipality (0). No integer
is_non_local query Filter transactions by cardholder estimated residence region not in merchant region (1) or cardholder estimated residence region in merchant region (0). No integer
is_regional_local query Filter transactions by cardholder estimated residence region not in merchant region (0) or cardholder estimated residence region in merchant region (1). No integer
issuer_country_a3 query Filter by issuer ISO-A3 country code. Example: DNK No [ string ]
online_physical query Filter transactions by online (0 = e-commerce) and physical store (1 = POS). No integer
outlet_country_a3 query Filter by outlet ISO-A3 country code. Example: DNK No [ string ]
outlet_id query Filter by outlet ID. Example: 99 No [ integer ]
outlet_mcc query Filter by MCC (Merchant Category Code) No [ integer ]
outlet_municipality_code query Filter by outlet municipality. Example: 3 No [ integer ]
outlet_name query Filter by outlet name. Includes full or partial matches. Example: Shop123 No string
outlet_region_code query Filter by outlet region code. Example: 10 No [ integer ]
outlet_zipcode query Filter by outlet zip code Example: 2100 No [ integer ]
past_month_count query Window for recurring customers. Default window is the past 12 months. Example: 5 Yes integer
vat_code query Filter by VAT number. Example: 87654321 No [ integer ]
Ocp-Apim-Subscription-Key header Yes string
Responses
Code Description
200 OK
400 Input error

/consumerSegmentation/rfm

GET

Summary

RFM

Description

Recency, Frequency and Monetization (RFM) - The consumers who have visited a merchant in given time period are segmented based on their RFM values.


You can quantify the value of different consumer segments and still cross-filter them.

For example, you can find out how recently German customers have made purchases, how frequently those with business cards shop, and what their turnover is.

Parameters
Name Located in Description Required Schema
buckets query Number of RFM buckets. Default: 3 | Minimum: 2 | Maximum: 100 No integer
business_private query Filter transactions by business (0 = business) and private (1 = private). No integer
currency query Set ISO-4217 currency code. Default currency code = EUR). Example: DKK No string
domestic_international query Filter cardholder transactions by domestic (0 = domestic) or international (1 = international). No integer
estimated_residence_country_a3 query Filter by cardholder ISO-A3 country code. Example: DNK No [ string ]
estimated_residence_municipality_code query Filter by customer municipality code. Example: 43 No [ integer ]
estimated_residence_region_code query Filter by cardholder region. Example: 3 No [ integer ]
group_by query Group output by one or more of the following values. Possible values: group_name, company_name, vat_code, outlet_country, outlet_region, outlet_municipality, outlet_zipcode, outlet_id, outlet_name, outlet_mcc, issuer_country, domestic_international, estimated_residence_municipality, estimated_residence_region, estimated_residence_country, is_municipality_local, is_regional_local, business_private, recency, frequency, monetary_value. No [ string ]
is_municipality_local query Filter transactions by the cardholder estimated residence being either in the merchant municipality (1) or outside the merchant municipality (0). No integer
is_non_local query Filter transactions by cardholder estimated residence region not in merchant region (1) or cardholder estimated residence region in merchant region (0). No integer
is_regional_local query Filter transactions by cardholder estimated residence region not in merchant region (0) or cardholder estimated residence region in merchant region (1). No integer
issuer_country_a3 query Filter by issuer ISO-A3 country code. Example: DNK No [ string ]
month_range_end query End month in a range of months. Example: 10 No integer
month_range_start query Initial month in a range of months Example: 5 No integer
online_physical query Filter transactions by online (0 = e-commerce) and physical store (1 = POS). No integer
outlet_country_a3 query Filter by outlet ISO-A3 country code. Example: DNK No [ string ]
outlet_id query Filter by outlet ID. Example: 99 No [ integer ]
outlet_mcc query Filter by MCC (Merchant Category Code) No [ integer ]
outlet_municipality_code query Filter by outlet municipality. Example: 3 No [ integer ]
outlet_name query Filter by outlet name. Includes full or partial matches. Example: Shop123 No string
outlet_region_code query Filter by outlet region code. Example: 10 No [ integer ]
outlet_zipcode query Filter by outlet zip code Example: 2100 No [ integer ]
quarter_range_end query End quarter in a range of quarters. Example: 3 No integer
quarter_range_start query Initial quarter in a range of quarters Example: 1 No integer
transaction_year query Filter transactions by year. Yes integer
vat_code query Filter by VAT number. Example: 87654321 No [ integer ]
week_number_range_end query End week in a range of weeks. Example: 52 No integer
week_number_range_start query Initial week in a range of weeks Example: 5 No integer
Ocp-Apim-Subscription-Key header Yes string
Responses
Code Description
200 OK
400 Input error

Models

RFMResponse

Name Type Description Required
values [ object ] No

RecurringCustomersGroupBy

Name Type Description Required
RecurringCustomersGroupBy string

RecurringCustomersResponse

Name Type Description Required
values [ object ] No

RfmGroupBy

Name Type Description Required
RfmGroupBy string

ValuesRFM

Name Type Description Required
group_name string No
company_name string No
vat_code integer No
outlet_country_a3 string No
outlet_region string No
outlet_municipality string No
outlet_zipcode integer No
outlet_id integer No
outlet_name string No
outlet_mcc integer No
transaction_year integer No
issuer_country_a3 string No
domestic_international string No
business_private string No
is_non_local string No
is_regional_local string No
is_municipality_local string No
estimated_residence_country_a3 string No
estimated_residence_region string No
estimated_residence_municipality string No
recency_bucket integer No
frequency_bucket integer No
monetization_bucket integer No
recency_min integer No
recency_max integer No
frequency_min number No
frequency_max number No
monetization_min number No
monetization_max number No
number_of_cards long No

ValuesRecurringCustomers

Name Type Description Required
group_name string No
company_name string No
vat_code integer No
outlet_country_a3 string No
outlet_region string No
outlet_municipality string No
outlet_zipcode integer No
outlet_id integer No
outlet_name string No
outlet_mcc integer No
transaction_year integer No
transaction_quarter integer No
transaction_month integer No
transaction_week integer No
transaction_date integer No
transaction_day integer No
number_of_cards long No
issuer_country_a3 string No
domestic_international string No
business_private string No
online_physical string No
is_non_local string No
is_regional_local string No
is_municipality_local string No
estimated_residence_country_a3 string No
estimated_residence_region string No
estimated_residence_municipality string No
number_of_transactions_before integer No
card_turnover_before number No
number_of_transactions_in_period integer No
card_turnover_in_period number No