Historical Comparison

Version: 1.0.0

Contact information:
API Support
datasuite@nexigroup.com

/historicalComparison

GET

Summary

Historical comparison

Description

The turnover is distributed over a year on a weekly, monthly, quarterly, or yearly basis. At the same time, the normalised turnover for each week, month, quarter, or year is calculated for each year. To give an identification of how the chosen year develops compared to the historic average, the index in percentage for these two values is also included in the response.

The sequential turnover is divided by the total turnover, which means that the turnover is normalized instead of being absolute numbers.

To get the response in the right format (week, month, quarter, or year), choose two years and choose the endpoint. By using the filter, you can choose to only look at a specific period or only include certain segments.

Parameters

Name	Located in	Description	Required	Schema
business_private	query	Filter transactions by business (0 = business) and private (1 = private).	No	integer
category_code	query	Filter by a category code To get all supported category codes, use MCC mapping endpoint under the Mapping tag. Example : 14	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, online_physical, merchant_country, merchant_region, merchant_municipality, vertical, category, issuer_country, domestic_international, estimated_residence_country, estimated_residence_region, estimated_residence_municipality, 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 ]
merchant_country_a3	query	Filter by a merchant ISO-A3 country code	No	[ string ]
merchant_municipality_code	query	Filter by a merchant municipality code To get all supported municipality codes, use Geographical mapping endpoint under the Mapping tag.	No	[ integer ]
merchant_region_code	query	Filter by a merchant region code To get all supported region codes, use Geographical mapping endpoint under the Mapping tag.	No	[ integer ]
month_range_end	query	End month in a range of months. Example: 10	No	integer
month_range_start	query		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 ]
vertical	query	Filter by a vertical To get all supported verticals, use MCC mapping endpoint under the Mapping tag. Example : Transportation	No	[ string ]
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
year_range_end	query	End year in a range of years. Minimum value: Four years earlier than current year Maximum value: Current Year	No	integer
year_range_start	query	Initial year in a range of years Minimum value: Four years earlier than current year Maximum value: Current Year	No	integer
Ocp-Apim-Subscription-Key	header		Yes	string

Responses

Code	Description
200	OK
400	Input error

Models

HistoricalComparisonGroupBy

Name	Type	Description	Required
HistoricalComparisonGroupBy	string

HistoricalComparisonResponse

Name	Type	Description	Required
values	[ object ]		No

ValuesHistoricalComparison

Name	Type	Required
transaction_year	integer	No
transaction_quarter	integer	No
transaction_month	integer	No
transaction_week	integer	No
merchant_country_a3	string	No
merchant_region	string	No
merchant_municipality	string	No
vertical	string	No
category	string	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_municipality	string	No
estimated_residence_region	string	No
normalised_card_turnover	number	No
normalised_number_of_transactions	number	No
normalised_number_of_cards	number	No