Benchmarking

Try It

Version: 1.0.0

Contact information:
API Support
datasuite@nexigroup.com

/benchmarking/YoY

GET

Summary

Top Level Year-Over-Year Benchmarking

Description

Year-Over-Year (YOY) comparison of a merchant performance against the performance of the market in percentage. This benchmark provides a high level comparison. The merchant values are a representation of all outlets belonging to the merchant. A baseline year and an analysis year are required parameters to limit the comparison. For more information, refer to the documentation.

Parameters
Name Located in Description Required Schema
analysis_year query Comparison analysis year Yes integer
baseline_year query Comparison baseline year Yes integer
business_private query Filter transactions by business (0 = business) and private (1 = private). No integer
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, merchant_group_name, merchant_company_name, merchant_vat_code, merchant_outlet_id, merchant_outlet_name, online_physical, is_refund, issuer_country, domestic_international, estimated_residence_municipality, estimated_residence_region, estimated_residence_country, is_municipality_local, is_regional_local, is_non_local, business_private, market_outlet_country, merchant_outlet_country, market_outlet_region, merchant_outlet_region, market_outlet_municipality, merchant_outlet_municipality, market_outlet_vertical, merchant_outlet_vertical, market_outlet_category, merchant_outlet_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_refund query Filter transactions by regular (0 = regular) and refund (1 = refund). 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 ]
market_outlet_category_code query Filter by market category code No [ integer ]
market_outlet_country_a3 query Filter market outlets by ISO-A3 country code No [ string ]
market_outlet_municipality_code query Filter market outlets by municipality code No [ integer ]
market_outlet_region_code query Filter market outlets by region code No [ integer ]
market_outlet_vertical query Filter by market vertical. Example: Transportation No [ string ]
merchant_outlet_category_code query Filter by merchant category code No [ integer ]
merchant_outlet_country_a3 query Filter merchant outlets by ISO-A3 country code No [ string ]
merchant_outlet_id query Filter by merchant outlet ID. Example: 99 No [ integer ]
merchant_outlet_municipality_code query Filter merchant outlets by municipality code No [ integer ]
merchant_outlet_name query Filter by merchant outlet name. Includes full or partial matches. Example: Shop123 No string
merchant_outlet_region_code query Filter merchant outlets by region code No [ integer ]
merchant_outlet_vertical query Filter by merchant vertical. Example: Transportation No [ string ]
merchant_vat_code query Filter by merchant VAT number. Example: 87654321 No [ integer ]
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
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_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 ]
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

/benchmarking/marketAverage

GET

Summary

Merchant Average Benchmarking

Description

Comparison between market performance and average performance of the merchant's outlets. For more information, refer to the documentation.

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
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, merchant_group_name, merchant_company_name, merchant_vat_code, merchant_outlet_id, merchant_outlet_name, online_physical, is_refund, issuer_country, domestic_international, estimated_residence_municipality, estimated_residence_region, estimated_residence_country, is_municipality_local, is_regional_local, is_non_local, business_private, market_outlet_country, merchant_outlet_country, market_outlet_region, merchant_outlet_region, market_outlet_municipality, merchant_outlet_municipality, market_outlet_vertical, merchant_outlet_vertical, market_outlet_category, merchant_outlet_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_refund query Filter transactions by regular (0 = regular) and refund (1 = refund). 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 ]
market_outlet_category_code query Filter by market category code No [ integer ]
market_outlet_country_a3 query Filter market outlets by ISO-A3 country code No [ string ]
market_outlet_municipality_code query Filter market outlets by municipality code No [ integer ]
market_outlet_region_code query Filter market outlets by region code No [ integer ]
market_outlet_vertical query Filter by market vertical. Example: Transportation No [ string ]
merchant_outlet_category_code query Filter by merchant category code No [ integer ]
merchant_outlet_country_a3 query Filter merchant outlets by ISO-A3 country code No [ string ]
merchant_outlet_id query Filter by merchant outlet ID. Example: 99 No [ integer ]
merchant_outlet_municipality_code query Filter merchant outlets by municipality code No [ integer ]
merchant_outlet_name query Filter by merchant outlet name. Includes full or partial matches. Example: Shop123 No string
merchant_outlet_region_code query Filter merchant outlets by region code No [ integer ]
merchant_outlet_vertical query Filter by merchant vertical. Example: Transportation No [ string ]
merchant_vat_code query Filter by merchant VAT number. Example: 87654321 No [ integer ]
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
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_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 ]
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

BenchmarkingAverageResponse

Name Type Description Required
values [ object ] No

BenchmarkingMarketAverageGroupBy

Name Type Description Required
BenchmarkingMarketAverageGroupBy string

BenchmarkingYearOverYearResponse

Name Type Description Required
values [ object ] No

BenchmarkingYoYGroupBy

Name Type Description Required
BenchmarkingYoYGroupBy string

ShareOfWalletResponse

Name Type Description Required
values [ object ] No

ValuesBenchmarkingAverage

Name Type Description Required
merchant_group_name string No
merchant_company_name string No
merchant_vat_code integer No
merchant_outlet_name string No
merchant_outlet_id integer No
transaction_year integer No
transaction_quarter integer No
transaction_month integer No
transaction_week integer No
online_physical string No
issuer_country_a3 string No
domestic_international string No
estimated_residence_country_a3 string No
estimated_residence_municipality string No
estimated_residence_region string No
is_non_local string No
is_regional_local string No
is_municipality_local string No
is_refund string No
business_private string No
market_outlet_country_a3 string No
market_outlet_region string No
market_outlet_municipality string No
market_outlet_vertical string No
market_outlet_category string No
market_average_card_turnover_per_outlet number No
market_average_number_of_transactions_per_outlet number No
market_average_number_of_cards_per_outlet number No
merchant_outlet_country_a3 string No
merchant_outlet_region string No
merchant_outlet_municipality string No
merchant_outlet_vertical string No
merchant_outlet_category string No
merchant_average_card_turnover_per_outlet number No
merchant_average_number_of_transactions_per_outlet number No
merchant_average_number_of_cards_per_outlet number No

ValuesBenchmarkingYearOverYear

Name Type Description Required
merchant_group_name string No
merchant_company_name string No
merchant_vat_code integer No
merchant_outlet_name string No
merchant_outlet_id integer No
baseline_year integer No
analysis_year integer No
transaction_quarter integer No
transaction_month integer No
transaction_week integer No
online_physical string No
issuer_country_a3 string No
domestic_international string No
estimated_residence_country_a3 string No
estimated_residence_municipality string No
estimated_residence_region string No
is_non_local string No
is_regional_local string No
is_municipality_local string No
is_refund string No
business_private string No
market_outlet_country_a3 string No
market_outlet_region string No
market_outlet_municipality string No
market_outlet_vertical string No
market_outlet_category string No
market_year_over_year_card_turnover number No
market_year_over_year_number_of_transactions number No
market_year_over_year_number_of_cards number No
merchant_outlet_country_a3 string No
merchant_outlet_region string No
merchant_outlet_municipality string No
merchant_outlet_vertical string No
merchant_outlet_category string No
merchant_year_over_year_card_turnover number No
merchant_year_over_year_number_of_transactions number No
merchant_year_over_year_number_of_cards number No

ValuesShareOfWallet

Name Type Description Required
group_name string No
company_name string No
vat_code integer No
country_a3 string No
region string No
municipality string No
outlet_id integer No
outlet_name string No
transaction_year integer No
transaction_quarter integer No
transaction_month integer No
transaction_week integer No
issuer_country_a3 string No
domestic_international string No
business_private string No
online_physical 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 string No
category string No
merchant_card_turnover_share double No
merchant_number_of_transactions_share double No
merchant_number_of_cards_share double No