Salla Docs
Merchant
Merchant
  • Merchant API
  • Salla OAuth 2.0
  • Merchant Dashboard
Partner APIs
Partner APIs
  • App API
  • Shipments & Fulfillment APIs
  • Salla AWB
  • Recurring Payments API
  • App Functions
  • Billing System Salla partners
  • Report Builder
  • App Onboarding
  • Communication Apps
Storefront
Storefront
  • Twilight Engine
  • Twilight SDK
  • Web Components
  • Ecommerce Events
  • Component Bundle
  • Change Log
Salla CLI
Merchant
Merchant
  • Merchant API
  • Salla OAuth 2.0
  • Merchant Dashboard
Partner APIs
Partner APIs
  • App API
  • Shipments & Fulfillment APIs
  • Salla AWB
  • Recurring Payments API
  • App Functions
  • Billing System Salla partners
  • Report Builder
  • App Onboarding
  • Communication Apps
Storefront
Storefront
  • Twilight Engine
  • Twilight SDK
  • Web Components
  • Ecommerce Events
  • Component Bundle
  • Change Log
Salla CLI
Salla - Opensource
Salla - Developers Community
  1. Report Builder
  • Overview
  • Getting Started
  • JMESPath Tutorial
  • Salla Reports Examples
  • Key Concepts
  • Report Types
    • Unit
    • Bar
    • Breakdown
    • Calendar
    • Distribution
    • Pipe
    • Plot
    • Ranking
    • Summary
    • Agrid
Merchant
Merchant
  • Merchant API
  • Salla OAuth 2.0
  • Merchant Dashboard
Partner APIs
Partner APIs
  • App API
  • Shipments & Fulfillment APIs
  • Salla AWB
  • Recurring Payments API
  • App Functions
  • Billing System Salla partners
  • Report Builder
  • App Onboarding
  • Communication Apps
Storefront
Storefront
  • Twilight Engine
  • Twilight SDK
  • Web Components
  • Ecommerce Events
  • Component Bundle
  • Change Log
Salla CLI
Merchant
Merchant
  • Merchant API
  • Salla OAuth 2.0
  • Merchant Dashboard
Partner APIs
Partner APIs
  • App API
  • Shipments & Fulfillment APIs
  • Salla AWB
  • Recurring Payments API
  • App Functions
  • Billing System Salla partners
  • Report Builder
  • App Onboarding
  • Communication Apps
Storefront
Storefront
  • Twilight Engine
  • Twilight SDK
  • Web Components
  • Ecommerce Events
  • Component Bundle
  • Change Log
Salla CLI
Salla - Opensource
Salla - Developers Community
  1. Report Builder

Getting Started

Salla Report Creator#

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
Just log in to your Partners Account, open the app you want to add the Report to by clicking on My Apps, and opening the app.
alt_text
Scroll down to the Report Creator section and click Create Report.
alt_text

Basic Info#

This will redirect you to the first step of creating the Report which is the Basic Info.
alt_text
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.
alt_text
The below table explains the basic information items.
ItemDescription
TitleThe Report title which will be displayed on the Merchant’s board
TagSelect the tags where the Report will be classified into.
After completing the Basic information, click Next to go to the second step.
alt_text

Source Configuration#

This step focuses on setting up the report primary data source.
alt_text
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.
alt_text

URL#

Only GET Methods are supported in data source APIs
Then enter the API Endpoint where you want to fetch the data from.
alt_text

Store Preview#

You can also view the results on a demo store after installing the app by choosing the store from the dropdown list.
alt_text

Data Mapping#

In this section you can create the report using Expressions or Builder.
Expression
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"
}
Then the JMESPath expression to fetch sales and age together would be:
{sales: sales, age: age}
This returns:
{
  "sales": 1200,
  "age": 35
}
As shown below.
alt_text
You can see the map output on the lower right side of the page.
alt_text
Click on the Save Component button to save the Report.
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.
Then repeat the same steps from the beginning.
Read more about the JMESpath tutorial and check the examples to create different types of reports.
Modified at 2026-03-03 13:30:31
Previous
Overview
Next
JMESPath Tutorial