Skip to main content

Reference

Branch & Regional Analytics

Enterprise only

Management dashboards at branch, regional, and national level, plus officer leaderboards and sector benchmarks.

The analytics module aggregates portfolio and officer data into management-level dashboards — branch, regional, and national — for bank and fintech partners.

Branch dashboard

GET/v1/analytics/branches/{branchId}

Branch-level dashboard: officer count, portfolio health distribution, revenue under management, loan penetration, platform adoption, alert-response SLA.

Response — 200

{
  "success": true,
  "data": {
    "branchName": "Victoria Island",
    "branchCode": "VI-001",
    "managerName": "Olufunke Adesanya",
    "totalOfficers": 8,
    "totalBusinesses": 222,
    "metrics": {
      "totalRevenueUnderManagementKobo": 100400000000,
      "loanPenetrationRate": 0.41,
      "platformAdoptionRate": 0.82,
      "businessesAtRisk": 31,
      "crossSellOpportunities": 38,
      "avgAlertResponseTimeHours": 4.6,
      "totalOutstandingLoansKobo": 26000000000
    },
    "portfolioHealth": { "green": 130, "amber": 61, "red": 31 }
  }
}

Branch officer leaderboard

GET/v1/analytics/branches/{branchId}/officers

All officers in the branch with performance metrics, sorted by engagement score by default.

Query parameters

FieldTypeRequiredNotes
sortBystringnoengagementScore (default), portfolioSize, loanPenetrationRate, avgResponseTime, totalRevenueUnderManagement.
sortOrderstringnodesc (default) or asc.

Branch alerts

GET/v1/analytics/branches/{branchId}/alerts

Aggregated alerts across all officers in the branch, sorted by severity then recency.

Query parameters

FieldTypeRequiredNotes
limitintegernoDefault 50, max 100.
offsetintegerno
severitystringnocritical or warning.
officerIdstringnoNarrow to one officer.

Branch cross-sell pipeline

GET/v1/analytics/branches/{branchId}/cross-sell-pipeline

Branch-wide cross-sell pipeline grouped by product with identified / pitched / converted funnel metrics.

Returns the funnel (identified → pitched → converted), potential revenue, conversion rates, and average deal size per product category.

Regional analytics

GET/v1/analytics/regions/{regionId}

Aggregate analytics for a region (multiple branches) with per-branch benchmarking.

Response — 200

{
  "success": true,
  "data": {
    "regionId": "lagos_island",
    "regionName": "Lagos Island Region",
    "totalBranches": 5,
    "totalOfficers": 42,
    "totalBusinesses": 1150,
    "metrics": {
      "totalRevenueUnderManagementKobo": 520000000000,
      "avgLoanPenetrationRate": 0.38,
      "avgPlatformAdoptionRate": 0.79,
      "totalBusinessesAtRisk": 172,
      "totalCrossSellOpportunities": 195
    },
    "portfolioHealth": { "green": 667, "amber": 311, "red": 172 },
    "branchBenchmarks": [
      {
        "branchCode": "VI-001",
        "branchName": "Victoria Island",
        "totalBusinesses": 222,
        "loanPenetrationRate": 0.41,
        "platformAdoptionRate": 0.82,
        "avgAlertResponseTimeHours": 4.6,
        "portfolioHealthGreenPercent": 0.59
      }
    ]
  }
}

National dashboard

GET/v1/analytics/national

Executive-level dashboard for the entire enterprise — regions, branches, officers, SMEs, portfolio health, product penetration, heat map.

Response — 200

Top-line totals (totalRegions, totalBranches, totalOfficers, totalSMEs), aggregate metrics, portfolioHealth, topRegions, productPenetration (by module), and a geographic heatMap of activity.

National sector benchmarks

GET/v1/analytics/national/sector-benchmarks

Industry-level benchmarks across the enterprise's SME portfolio.

Query parameters

FieldTypeRequiredNotes
sectorstringnoe.g. food_beverage, logistics, technology, construction, retail.

Each benchmark includes average monthly revenue, net margin, expense ratio, days receivable, debt-to-equity, loan penetration, average health score, and default rate for the sector.

403 response for retail keys

{
  "success": false,
  "error": {
    "code": "ENTERPRISE_ONLY",
    "message": "This endpoint requires an enterprise subscription. Contact sales at https://finorabusiness.com/contact",
    "requestId": "req_..."
  }
}

Need these dashboards for your bank?

Branch, regional, and national analytics are part of the enterprise tier. Contact sales to discuss the integration and data-sharing agreement.

Related endpoints

Reference index

Back to all modules