Historical Comparison

Try It

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 based on inputs. The normalised turnover for each week, month, quarter or year for each chosen year is calculated, and the comparison in percentage is also returned. For more information, refer to the documentation.

Parameters
Name Located in Description Required Schema
business_private query Narrow your search between business (0 = business) or private (1 = private) transactions. Example: 1 No integer
category_code query Choose a category code value. Only returns data for the given category. To get all category codes, use "All supported category codes with corresponding vertical domain" endpoint under the Mapping tag. Example : 14 No [ integer ]
domestic_international query Narrow your search between domestic (0 = domestic) or international (1 = international) cardholder transactions. Example: 1 No integer
estimated_residence_country_a3 query The country code in ISO-A3. Narrow your search for the cardholders from defined country only. To get all supported region codes, use Regions and municipalities mapping endpoint under the Mapping tag. This endpoint supports array as an input. Define all input parameters and comma-separate them to filter on multiple values. Example: DNK No [ string ]
estimated_residence_municipality_code query The municipality code for customers for the which you want to receive the data from. To get all supported area codes, use Regions and municipalities mapping endpoint under the Mapping tag. This endpoint supports array as an input. Define all input parameters and comma-separate them to filter on multiple values. Example: 43 No [ integer ]
estimated_residence_region_code query Narrow your search for the cardholders from a specific region only. To get all supported region codes, use Regions and municipalities mapping endpoint under the Mapping tag. This endpoint supports array as an input. Define all input parameters and comma-separate them to filter on multiple values. Example: 3 No [ integer ]
group_by query Specify how the data should be grouped. Possible values: transaction_quarter, transaction_month, transaction_week, online_physical, merchant_country, merchant_region, merchant_municipality, merchant_destination, vertical, category, issuer_country, domestic_international, estimated_residence_country, estimated_residence_region, estimated_residence_municipality, is_municipality_local, is_regional_local, business_private. This endpoint supports array as an input. Define all input parameters and comma-separate them to group by on multiple values. Example: transaction_year No [ string ]
is_municipality_local query Narrow your search by looking at municipality-local (1) or not municipality-local (0), which are transactions where the estimated residence municipality is same (1) or not the same (0) as the merchant's municipality. Example: 1 No integer
is_regional_local query Narrow your search by looking at regional-local (1) or not regional-local (0), which are transactions where the estimated residence region is same (1) or not the same (0) as the merchant's region. Example: 1 No integer
issuer_country_a3 query Country code value in ISO-A3. Narrow down your search to a specific issuer country of cardholders. This endpoint supports array as an input. Define all input parameters and comma-separate them to filter on multiple values. Example: DNK No object
merchant_country_a3 query Choose a country code value in ISO-A3 format. Only returns the data for the given country. To get all ISO-A3 supported countries, use "Codes for all supported countries" endpoint under the Mapping tag. Example : DNK No [ string ]
merchant_destination query Choose a destination for merchant. Only returns the data for the given destination. To get all supported destinations, use "Codes for all supported regions, municipalities and destinations" endpoint under the Mapping tag. Example : Wonderful Copenhagen No [ string ]
merchant_municipality_code query Choose an municipality code value. Only returns the data for the given merchant municipality. To get all supported municipality codes, use "Codes for all supported regions, municipalities and destinations" endpoint under the Mapping tag. Example : 10 No [ integer ]
merchant_region_code query Choose a region code value. Only returns data for the given merchant region. To get all supported region codes, use "Codes for all supported regions, municipalities and destinations" endpoint under the Mapping tag. Example : 50 No [ integer ]
month_range_end query The end month until when will the date range last. Example: 10 No integer
month_range_start query No integer
online_physical query Narrow your search between transactions made online (0 = ecom) and in the physical store (1 = pos) only. Example: 1 No integer
quarter_range_end query The end quarter until when will the date range last. Example: 3 No integer
quarter_range_start query The start quarter from when will the date range start. Example: 1 No integer
vertical query Choose a vertical value. Only returns the data for the given vertical. To get all vertical values, use "All supported category codes with corresponding vertical domain" endpoint under the Mapping tag. Example : Transportation No [ string ]
week_number_range_end query The end week number until when the date range will last. Example: 52 No string
week_number_range_start query The start week number from when will the date range start. Example: 5 No string
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

StringList

Name Type Description Required
list [ string ] No

ValuesHistoricalComparison

Name Type Description 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
merchant_destination 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_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 double No
normalised_number_of_transactions double No
normalised_number_of_cards double No