Index
Version: 1.0.0
Contact information:
API Support
datasuite@nexigroup.com
/index
GET
Summary
Index
Description
The Index resource is used to compare the performance of different categories of industries over time. This comparison can be week-to-week based, so if you choose to compare week 5 against week 10, you will get a percentage value stating how much an industry has changed when comparing only these two weeks against each other. Five different time periods are available: Weekly, Monthly, and Quarterly are specific for the chosen period. Then there are the current year and last year, which are indexes for a weekly period of time for the current/last year versus the historical average for the same period of time.
Use the following four indexes returning the percentage change to further develop your own hypothesis. Here is a list of these indexes:
* Card Turnover Index: Shows if the amount of turnover is increasing or decreasing in percentage.
-
Number of Transactions Index: Shows if the number of transactions is increasing or decreasing in percentage.
-
Number of Cards Index: Shows the number of cards (number of card spending/cardholders) development in percentage.
-
Average Merchant Card Turnover Index: Shows the development for card turnover for merchants on average for the given period in percentage.
If you are interested in a high-level overview across the categories, try using our Group By function. It offers segmentation of the market where you can see an overall turnover, how many transactions took place online and/or in person, how many cards were domestic and international, and also how many cards were business and private.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| analysis_month | query | Comparison analysis month | No | integer |
| analysis_quarter | query | Comparison analysis quarter | No | integer |
| analysis_week | query | Comparison analysis week | No | integer |
| analysis_year | query | Comparison analysis year | Yes | integer |
| baseline_month | query | Comparison baseline month | No | integer |
| baseline_quarter | query | Comparison baseline quarter | No | integer |
| baseline_week | query | Comparison baseline week | No | integer |
| baseline_year | query | Comparison baseline year | Yes | integer |
| 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: 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 ] |
| online_physical | query | Filter transactions by online (0 = e-commerce) and physical store (1 = POS). | 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 ] |
| Ocp-Apim-Subscription-Key | header | Yes | string |
Responses
| Code | Description |
|---|---|
| 200 | OK |
| 400 | Input error |
Models
IndexGroupBy
| Name | Type | Description | Required |
|---|---|---|---|
| IndexGroupBy | string |
IndexResponse
| Name | Type | Description | Required |
|---|---|---|---|
| values | [ object ] | No |
ValuesIndex
| Name | Type | Description | Required |
|---|---|---|---|
| baseline_year | integer | No | |
| baseline_quarter | integer | No | |
| baseline_month | integer | No | |
| baseline_week | integer | No | |
| analysis_year | integer | No | |
| analysis_quarter | integer | No | |
| analysis_month | integer | No | |
| analysis_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 | |
| card_turnover_index | number | No | |
| number_of_transactions_index | number | No | |
| number_of_cards_index | number | No | |
| average_merchant_card_turnover_index | number | No |