The Market Insights API endpoints return data in JSON format about the various market trends. This page will show you some useful guides and tutorials to get you started.
Getting Started
To get started you need following:
- Subscription key
Tutorial 1: Local Web Client
Getting started sometimes requires long setup and different configurations. Sometimes you might just want to see how quick the API’s response is, what's the format of a response or to see a size of it. To get you all these answers right away, use our Local Web Client which you get access to by clicking "Try it" in the API documentation. Remember, you still need a Subscription key.
Step 1
Navigate to APIs and open Market Insight API. Choose an endpoint of your interest and click on the "Try it out" button.
Step 2
Fill in all required fields, including a Subscription key and hit the execute button. You should receive a response within couple of seconds. Congratulations! You have just successfully used our Local Web Client.
"Ocp-Apim-Subscription-Key" is the last field and is required for you to execute your query.
Filters
Before diving into filters, you need to find the category codes for each category. For those there is a mapping endpoint, witch will return all the needed information.
If you want to test the filters, you can add them in the texts fields. If the parameter has the type array, you can add multiple values separated by a comma. These will be marked in the table so you know which parameters are arrays.
Tutorial 2: Postman
Postman is an application used for API testing. The HTTP client tests HTTP requests, utilizing a graphical user interface, through which different types of responses need to be validated. To get started with Postman and Market Insights, here is a quick guide (Example for index).
Remember all requests are GET requests
Step 1
Enter the URL in the request field and be sure the request is set to GET.
Step 2
You need to add the "Ocp-Apim-Subscription-Key" to the header. To do this, click on the "Headers" tab and add the key and value.
Step 3
To add a filter, click on the "Params" tab and add the key and value. The key is the filter name and the value is the filter value.
If a filter is an array, you can add multiple values separated by a comma.
Step 4
It's possible to customise the response by using the group by input parameter. When using this input, the data will be structured by the inputs with the corresponding values for the specific service. (Group By)
Step 5
You should now be ready to do a request and get the response, by clicking send.
Tutorial 3: Microsoft Excel
Excel supports pulling data from a wide variety of data sources. The basic process is that you first identify the type of data source and then the location. This tutorial will demonstrate a data import from Market Insights API endpoint: BASE_URL/marketInsights/averageSpend
Note: Mac doesn't support power query, instead see one of the other tutorials.
Step 1
We tell Excel that we want to retrieve data from an external source by first identifying the type of source. This is done by selecting the appropriate ribbon icon (From Web) from the Data tab as shown below.
Step 2
Our goal is to get data From Web. Fill in the connection wizard as shown on a picture bellow. Remember to type in the subscription key value into the request header parameters.
HTTP HEADER: "Ocp-Apim-Subscription-Key" (The header isn't listed in the dropdown, so you will need to type it in.)
The first time you send a request a box will appear asking you to confirm that you want to connect to the server. Click "Connect"
Step 3
Start by finding the list in the data. Click through any single records until you find a list. Click it to open the list of Records or Lists.
Step 4
Once you have found the list you are looking for; the list needs to be converted to a table for Excel to use. Click “To Table” to convert it.
Step 5
Once you have the list as a table, you need to specify which columns you want excel to make use of. Click the icon with two arrows pointing away from one another to expand the table. You may want to rename the table before doing this. To do so, double click the name and type a new one. When all good, click "OK".
Step 6
You can now click Close & Load to continue with your data exploration in Excel.
Tutorial 4: Qlik
In this tutorial, we will show how to get data in to Qlik, by using the REST service in Qlik.
Step 1
First when you are logged in to the Qlik cloud portal, you need to establish a new data connection, which is done by clicking at "Start with data" and then choose "Data connection".
Step 2
Then a window with all the supported data connections for Qlik is shown. Scroll down to find the "REST" or search for it, and click on it.
Step 3
Now you need to provide the URL, which should be used for the data connection. For this you can use the local web client, and copy the URL from the wanted endpoint. Don't specify any filters now, this is done in next step.
An example of a URL: https://data.netsfuturepayments.eu/v1/marketInsights/averageSpend
Step 4
After filling in the URL, scroll down to the section called "Additional request parameters". In this section you need to fill in the "Ocp-Apim-Subscription-Key" in to the "Query header". In the value filed fill in your provided subscription key.
Above the "Query headers" is the "Query parameters" which can be used for adding filters. As an example you want only e-commerce, and the you fill in the name of the filter: "online_physical" and the value is then 0.
If you want more filters, you add more by clicking the "+" button in the "Query parameters" section.
When you are done adding filters, it's possible to test the connection, and if the test is a success click the green button "create and analyze".
Step 5
The endpoint is now called and you will get a preview of the data in a table by clicking on the left, where the response values in this example is called "values". It can have different names, click here. Then click the green button "Next".
Step 6
You are now in the data manager where you can link to other data, and work with the data like you want, before you want to create graphs. When all good here, you click "Load Data".
Step 7
You will now be provided with a message saying "Your data was successfully loaded". From here you can go back and add more data or click "Go to sheet", where you can start create graphs.
Step 8
When you click "Go to sheet", you will be presented for three tabs. Depending on what you want you can either choose "Explore the data" for insights created by qlik or "Create new analytics" to create your own insights.