Using the Report creator helps quickly create tailored Reports that fetch live store data, visualize key metrics, and display them inside the merchant’s reports dashboard. This guide walks you through the simple steps to set up and manage your own Reports.Please ensure your data source ( API ) is ready and is accessible publicly as well as it implements authentication mechanism as described here. Basic Info#
This will redirect you to the first step of creating the Report which is the Basic Info.Here you will need to fill in the Component Title in Arabic and English as well as add the component Tags. You can select more than one tag for the component.The below table explains the basic information items.| Item | Description |
|---|
| Title | The Report title which will be displayed on the Merchant’s board |
| Tag | Select the tags where the Report will be classified into. |
After completing the Basic information, click Next to go to the second step.Source Configuration#
This step focuses on setting up the report primary data source.On the left side you can choose the Display Type and the URL where you want to fetch data from. On the right hand side you can select the demo store from the drop down list, this will allow you to preview the Report in the demo store.Display Type#
Select the display type for the Report from the dropdown menu.URL#
Only GET Methods are supported in data source APIs
Store Preview#
You can also view the results on a demo store after installing the app by choosing the store from the dropdown list.Data Mapping#
In this section you can create the report using Expressions or Builder.Refer to the
JMESPath tutorial to know more about expressions. In this example we can write the following expression to display the age and sales Report as shown below.
{
"sales": 1200,
"age": 35,
"name": "Ali"
}
{
"sales": 1200,
"age": 35
}
You will find the Report listed in the Report Builder section of the App Details page.To create more Reports click on the New Item button.
Maximum 15 Reports can be created for each App.
