1. Report Builder
Salla Platform Docs
  • Embedded SDK
    • Overview
    • Getting Started
    • Create an Embedded App
    • Authentication
    • App Design Guidelines
    • Installation
    • Playground
  • Auth Module
    • Get Token
    • Client Introspect
    • Refresh Token
  • Page Module
    • External Redirects
    • Navigation
    • Set Page Title
  • Nav Module
    • Create Navbar Action
    • Listen for Navbar Actions
    • Clearing Navbar Actions
    • Add Navbar Item
    • Update Navbar Item
    • Listen for Navbar Item Click
    • Remove Navbar Item
  • UI Module
    • Confirm Dialogs
    • Toast Notifications
    • Loading States
    • Breadcrumbs
  • Checkout Module
    • Create Checkout
    • Get App Add-ons
    • Subscribe for Payment Result
  • Endpoints
    • Token Introspect
      POST
  • Resources
    • Support
    • Common Examples
  • Report Builder
    • Overview
    • Getting Started
    • JMESPath Tutorial
    • Understanding the Report Lifecycle
    • Salla Reports Examples
    • Set up Store data using merchant APIs
    • Report Types
      • Unit
      • Bar
      • Breakdown
      • Calendar
      • Distribution
      • Pipe
      • Plot
      • Ranking
      • Summary
      • Agrid
    • APIs
      • Token Introspect
  • App Onboarding
    • Overview
    • Get Started
    • Interfaces and Responses
    • Example
Merchant
Merchant
  • Merchant API
  • Embedded SDK
  • Salla OAuth 2.0
Storefront
Storefront
  • Twilight Engine
  • Twilight SDK
  • Web Components
  • Ecommerce Events
  • Component Bundle
  • Checkout APIs
  • Change Log
App Functions
Partner APIs
Partner APIs
  • App API
  • Shipments & Fulfillment APIs
  • Salla AWB
  • Recurring Payments API
  • Billing System Salla partners
  • Communication Apps
Dev Tools
Dev Tools
  • Partners Agent Kit
  • Salla Apps Playbook
  • Salla CLI
Merchant
Merchant
  • Merchant API
  • Embedded SDK
  • Salla OAuth 2.0
Storefront
Storefront
  • Twilight Engine
  • Twilight SDK
  • Web Components
  • Ecommerce Events
  • Component Bundle
  • Checkout APIs
  • Change Log
App Functions
Partner APIs
Partner APIs
  • App API
  • Shipments & Fulfillment APIs
  • Salla AWB
  • Recurring Payments API
  • Billing System Salla partners
  • Communication Apps
Dev Tools
Dev Tools
  • Partners Agent Kit
  • Salla Apps Playbook
  • Salla CLI
Salla - Opensource
Salla - Developers Community
  1. Report Builder

Salla Reports Examples

In this article we will provide you with an example for Unit and Distribution Reports in Salla Partners Portal, using both the Expression and Builder.

Unit Report#

The Unit Report displays a single metric or value, making it ideal for counts, totals, or other standalone figures.
After creating a Report, select Unit as the type from the dropdown menu. In this example, the Unit Report will show Store Sales Change.
alt_text
Then follow the below steps for each method
Expression
Builder
Use the following JMESPath expression:
@.{value: data.rows[0][1], change: data.rows[0][3], unit: 'Sales'}
Explanation:
1.
@.{ ... } → Builds a custom object for display.
2.
value: data.rows[0][1] → Points to column 1 (total_sales). Example: 10894.53.
3.
change: data.rows[0][3] → Points to column 3 (total_shipping). Example: 1615.45.
4.
unit: 'Sales' → Static label for the metric.
Final Evaluated Object (with the mock data)
{
  value: 10894.53,   // total_sales
  change: 1615.45,   // total_shipping
  unit: "Sales"
}
So this expression @.{value: data.rows[0][1], change: data.rows[0][3], unit: 'Users'} tells the template:
“Show the total sales as the main value, the total shipping as the change, and label it with the unit Sales.”
The result will be shown as follows.
alt_text

Distribution Report#

The Distribution Report visualizes parts of a whole with bar segments and legends. It’s perfect for ratios like browser usage, payment methods, or customer groups.
alt_text
To create the distribution Report, after selecting the Distribution display type, then follow the below steps for each method.
Builder
Expressions
Using the builder you can simply enter the value or the location of the value. In this example, it shows the total sales, average and two distributions which are Discounted and Orders.
alt_text
After choosing the display type and URL, choose the builder type on the map panel.
alt_text
In the builder you can enter the expression for each item or use the builder, as shown in the below example. The value is fetched from data.rows[0][1], change is set to 100 and average is set to 40.
alt_text
After that you need to enter the distribution details, click on builder to enter the data.
alt_text
This will display the add item button, click on it to add a new item.
alt_text
After that, click on the item to fill in the item details.
alt_text
Fill in the details of the item as needed, you have the option to choose expression or builder for each item.
alt_text
You can watch the changes on the component as you build it on the right side of the page.
alt_text
Add more items by clicking on the New Item button.
alt_text
This will add a new item in the map, you can expand it to enter the item details.
alt_text
To sum up;
Use Expressions for flexibility and direct mapping of JSON data.
Use the Builder for a simpler, guided setup.
Both methods achieve the same results choose the one that fits your workflow best.
Modified at 2026-05-11 11:32:34
Previous
Understanding the Report Lifecycle
Next
Set up Store data using merchant APIs