The Simiz dashboard provides real-time analytics to help you understand your payment performance. You can also access analytics via API.

API reference

Two analytics endpoints are available:
EndpointScopeDescription
GET /api/v1/projects/{projectId}/analytics/dashboardPer projectStats for a specific project
GET /api/v1/organizations/{organizationId}/analytics/dashboardPer organizationStats across all projects (with optional environment filter)

Query parameters

ParameterValuesDefaultDescription
periodtoday, week, month, quarter, year, custommonthTime period
startDateISO 8601Start date (required when period=custom)
endDateISO 8601End date (required when period=custom)
comparestringCompare with previous period
environmentSANDBOX, PRODUCTIONFilter by environment (org-level only)

Response structure

The dashboard endpoint returns a comprehensive analytics object:
{
  "overview": {
    "totalVolume": 2500000,
    "transactionCount": 342,
    "successRate": 94.7,
    "averageTransactionValue": 7310,
    "pendingAmount": 45000
  },
  "comparison": {
    "volumeChange": 12.5,
    "countChange": 8.3,
    "successRateChange": 1.2
  },
  "volumeByDay": [
    { "date": "2026-02-01", "amount": 85000, "count": 12 },
    { "date": "2026-02-02", "amount": 92000, "count": 15 }
  ],
  "byStatus": {
    "COMPLETED": { "count": 324, "amount": 2300000 },
    "FAILED": { "count": 18, "amount": 200000 }
  },
  "byPaymentMethod": {
    "ORANGE_MONEY": { "count": 200, "amount": 1500000, "successRate": 96.0 },
    "MTN_MOMO": { "count": 142, "amount": 1000000, "successRate": 92.5 }
  },
  "topCustomers": [
    {
      "id": "cus_abc",
      "name": "John",
      "email": "john@example.com",
      "totalSpent": 150000,
      "transactionCount": 12
    }
  ],
  "recentActivity": {
    "hourlyVolume": [
      { "hour": 0, "amount": 5000, "count": 1 },
      { "hour": 9, "amount": 120000, "count": 18 }
    ]
  }
}

Key metrics

MetricDescription
Total volumeSum of all transaction amounts
Transaction countNumber of transactions
Success ratePercentage of successful transactions
Average transaction valueVolume ÷ Count
Pending amountAmount still processing

Breakdowns

DimensionDetails
By dayDaily volume and count for the selected period
By statusCount and amount per transaction status
By payment methodCount, amount, and success rate per method
Top customersHighest-spending customers
Hourly activityVolume and count per hour (for recent activity)