Before And After
Version: 1.0.0
Contact information:
API Support
datasuite@nexigroup.com
/beforeAndAfter
GET
Summary
Before And After
Description
Where do you and your stores fit into the customer journey? Do you need to broaden your store's product assortment since consumers always visit similar stores afterwards?
Or maybe partner up with the transportation service that your customers always use prior to visiting you? If so, this is the right feature for you to investigate.
Choose a number of days before and after to include other merchant visits and see your consumers' preferences.
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 | No | 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 | No | 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_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, issuer_country, domestic_international, estimated_residence_municipality, estimated_residence_region, estimated_residence_country, is_municipality_local, is_regional_local, business_private, merchant_country, merchant_region, merchant_municipality, vertical, category. | 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 |
| is_same_store_after | query | Transaction after happened in the same store (0 = not in the same store) or (1 = in the same store). | No | integer |
| is_same_store_before | query | Transaction before happened in the same store (0 = not in the same store) or (1 = in the same store). | 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 |
| 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 |
| range_of_days | query | Number of days before and after. A day is defined as a period of 24 hours relative to the time of the transaction. For example, for a transaction at 23:30, everything until 23:30 the following day is day 0. Possible values are 0-7. Default is 7. | No | integer |
| transaction_date | query | Filter transactions by date(s). Example: YYYY-MM-DD | No | [ date ] |
| transaction_day | query | Filter transactions by day(s). Example: 15 | No | [ integer ] |
| transaction_month | query | Filter transactions by months(s). Example: 5 | No | [ integer ] |
| transaction_quarter | query | Filter transactions by quarter(s). Example: 1 | No | [ integer ] |
| transaction_week | query | Filter transactions by week(s). Example: 20 | No | [ integer ] |
| transaction_year | query | Filter transactions by year(s). | No | [ 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
BeforeAndAfterGroupBy
| Name | Type | Description | Required |
|---|---|---|---|
| BeforeAndAfterGroupBy | string |
BeforeAndAfterResponse
| Name | Type | Description | Required |
|---|---|---|---|
| values | [ object ] | No |
ValuesBeforeAndAfter
| 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_day | integer | No | |
| transaction_date | integer | No | |
| card_turnover | number | No | |
| number_of_transactions | integer | No | |
| number_of_cards | long | 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 | |
| vertical_before | string | No | |
| category_before | string | No | |
| merchant_region_before | string | No | |
| merchant_municipality_before | string | No | |
| merchant_country_a3_before | string | No | |
| card_turnover_before | number | No | |
| number_of_transactions_before | integer | No | |
| vertical_after | string | No | |
| category_after | string | No | |
| merchant_region_after | string | No | |
| merchant_municipality_after | string | No | |
| merchant_country_a3_after | string | No | |
| card_turnover_after | number | No | |
| number_of_transactions_after | integer | No |