Get dashboard stats

curl --request GET \
  --url https://api.wava.co/v1/merchant/{storeId}/dashboard/stats \
  --header 'x-auth-token: <api-key>'

const options = {method: 'GET', headers: {'x-auth-token': '<api-key>'}};

fetch('https://api.wava.co/v1/merchant/{storeId}/dashboard/stats', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "result": {
    "currency": "COP",
    "date_from": "2026-04-01",
    "date_to": "2026-04-30",
    "total_revenue": 10000000,
    "total_orders": 142,
    "conversion_rate": 85.5,
    "delta_revenue_pct": 12.5,
    "delta_orders_pct": 8.3,
    "daily_revenue": [
      {
        "date": "2026-04-01",
        "value": 50000
      },
      {
        "date": "2026-04-02",
        "value": 0
      }
    ],
    "gateway_split": [
      {
        "gateway": "breb",
        "tpv": 7000000,
        "pct": 0.7
      },
      {
        "gateway": "nequi",
        "tpv": 2000000,
        "pct": 0.2
      },
      {
        "gateway": "daviplata",
        "tpv": 1000000,
        "pct": 0.1
      }
    ],
    "fees_vs_net": [
      {
        "date": "2026-04-01",
        "net_to_merchant": 47500,
        "fees": 2500
      },
      {
        "date": "2026-04-02",
        "net_to_merchant": 0,
        "fees": 0
      }
    ]
  }
}

{
  "code": 4001,
  "message": "Payment gateway is required",
  "error": true,
  "api_code": "PAYMENT_GATEWAY_REQUIRED",
  "description": "A payment gateway must be specified to process the order",
  "gateway_name": "Nequi",
  "provided_currency": "USD",
  "supported_currency": "COP",
  "validation_errors": [
    {
      "field": "phone_number",
      "message": "Phone number is required for Nequi payments"
    }
  ]
}

{
  "code": 4001,
  "message": "Payment gateway is required",
  "error": true,
  "api_code": "PAYMENT_GATEWAY_REQUIRED",
  "description": "A payment gateway must be specified to process the order",
  "gateway_name": "Nequi",
  "provided_currency": "USD",
  "supported_currency": "COP",
  "validation_errors": [
    {
      "field": "phone_number",
      "message": "Phone number is required for Nequi payments"
    }
  ]
}

{
  "code": 4001,
  "message": "Payment gateway is required",
  "error": true,
  "api_code": "PAYMENT_GATEWAY_REQUIRED",
  "description": "A payment gateway must be specified to process the order",
  "gateway_name": "Nequi",
  "provided_currency": "USD",
  "supported_currency": "COP",
  "validation_errors": [
    {
      "field": "phone_number",
      "message": "Phone number is required for Nequi payments"
    }
  ]
}

{
  "code": 7001,
  "api_code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "description": "An unexpected error occurred while processing your request",
  "error": true
}

Merchant Dashboard

Get dashboard stats

Returns all data needed to render the merchant dashboard in a single call: KPI cards, daily revenue trend, gateway split, and fees vs net breakdown.

Authentication: Merchant JWT (x-auth-token). The :storeId in the path must be included in the JWT’s stores array — otherwise the endpoint returns 401.

Timezone: All date parameters are interpreted in COT (UTC-5). date_to is inclusive end-of-day. Dates in the response are COT calendar dates.

Currency filter: Strict — a store with both COP and USD wallets that requests currency=COP will receive only COP data.

Zero-days: daily_revenue and fees_vs_net include an entry for every day in the range, including days with no transactions (value: 0, fees: 0, net_to_merchant: 0). This ensures chart libraries render a continuous line/bar without gaps.

Delta calculations: delta_revenue_pct and delta_orders_pct compare the requested window against the immediately preceding window of equal length. A 30-day request (Apr 1–Apr 30) compares against the 30 days prior (Mar 2–Mar 31). Returns null when the previous window has zero activity (avoids division by zero).

Gateway split: Only includes gateways for which fee data has been synced from the ledger (Order_financials). pct values sum to ~1.0 with floating-point tolerance.

GET

merchant

{storeId}

dashboard

stats

Get dashboard stats

curl --request GET \
  --url https://api.wava.co/v1/merchant/{storeId}/dashboard/stats \
  --header 'x-auth-token: <api-key>'

const options = {method: 'GET', headers: {'x-auth-token': '<api-key>'}};

fetch('https://api.wava.co/v1/merchant/{storeId}/dashboard/stats', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "result": {
    "currency": "COP",
    "date_from": "2026-04-01",
    "date_to": "2026-04-30",
    "total_revenue": 10000000,
    "total_orders": 142,
    "conversion_rate": 85.5,
    "delta_revenue_pct": 12.5,
    "delta_orders_pct": 8.3,
    "daily_revenue": [
      {
        "date": "2026-04-01",
        "value": 50000
      },
      {
        "date": "2026-04-02",
        "value": 0
      }
    ],
    "gateway_split": [
      {
        "gateway": "breb",
        "tpv": 7000000,
        "pct": 0.7
      },
      {
        "gateway": "nequi",
        "tpv": 2000000,
        "pct": 0.2
      },
      {
        "gateway": "daviplata",
        "tpv": 1000000,
        "pct": 0.1
      }
    ],
    "fees_vs_net": [
      {
        "date": "2026-04-01",
        "net_to_merchant": 47500,
        "fees": 2500
      },
      {
        "date": "2026-04-02",
        "net_to_merchant": 0,
        "fees": 0
      }
    ]
  }
}

{
  "code": 4001,
  "message": "Payment gateway is required",
  "error": true,
  "api_code": "PAYMENT_GATEWAY_REQUIRED",
  "description": "A payment gateway must be specified to process the order",
  "gateway_name": "Nequi",
  "provided_currency": "USD",
  "supported_currency": "COP",
  "validation_errors": [
    {
      "field": "phone_number",
      "message": "Phone number is required for Nequi payments"
    }
  ]
}

{
  "code": 4001,
  "message": "Payment gateway is required",
  "error": true,
  "api_code": "PAYMENT_GATEWAY_REQUIRED",
  "description": "A payment gateway must be specified to process the order",
  "gateway_name": "Nequi",
  "provided_currency": "USD",
  "supported_currency": "COP",
  "validation_errors": [
    {
      "field": "phone_number",
      "message": "Phone number is required for Nequi payments"
    }
  ]
}

{
  "code": 4001,
  "message": "Payment gateway is required",
  "error": true,
  "api_code": "PAYMENT_GATEWAY_REQUIRED",
  "description": "A payment gateway must be specified to process the order",
  "gateway_name": "Nequi",
  "provided_currency": "USD",
  "supported_currency": "COP",
  "validation_errors": [
    {
      "field": "phone_number",
      "message": "Phone number is required for Nequi payments"
    }
  ]
}

{
  "code": 7001,
  "api_code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "description": "An unexpected error occurred while processing your request",
  "error": true
}

Authorizations

x-auth-token

string

header

required

Merchant session JWT (dashboard login). The store in the path must be in the token's stores array.

Path Parameters

storeId

integer

required

The store ID to fetch dashboard data for. Must be owned by the authenticated user.

Example:

2366

Query Parameters

currency

string

required

3-letter currency code (e.g. COP, USD).

Pattern: ^[A-Z]{3}$

Example:

"COP"

date_from

string<date>

required

Start of the date range (YYYY-MM-DD, COT timezone, inclusive).

Example:

"2026-04-01"

date_to

string<date>

required

End of the date range (YYYY-MM-DD, COT timezone, inclusive end-of-day).

Example:

"2026-04-30"

Response

Dashboard stats

result

object

Show child attributes

API Reference

Endpoints

Get dashboard stats

Authorizations

Path Parameters

Query Parameters

Response