Developer Center

Indicators API

Last Updated: Oct 03, 2018 04:15PM CEST

URL

/api/indicators/{INDICATOR_NAME}

Description

Retrieve various performance indicators for the organization. Performance indicator descriptions can be found in our user guide.

Methods

GET Indicator

Retrieves the result of computing an indicator by it's unique name. Response is a map of the indicator name to its value which may be an integer or a decimal depending on the indicator.

Possible indicators to use include

Clients
NUM_CLIENTS
NUM_ACTIVE_CLIENTS
NUM_INACTIVE_CLIENTS
NUM_OPEN_CLIENTS
NUM_CLOSED_CLIENTS
NUM_EXITED_CLIENTS
NUM_PENDING_APPROVAL_CLIENTS
Active Pure Groups
NUM_GROUPS_BORROWING
AVERAGE_GROUP_SIZE
NUM_GROUP_BORROWERS
NUM_INDIVIDUAL_BORROWERS
PERCENTAGE_OF_FEMALE_BORROWERS
NUM_GROUPS_SAVING
NUM_INDIVIDUAL_SAVERS
NUM_GROUP_SAVERS
NUM_GROUPS
NUM_HYBRID_GROUPS_BORROWING
NUM_HYBRID_GROUP_BORROWERS
Deposits
NUM_ACTIVE_SAVINGS_ACCOUNTS
TOTAL_DEPOSITS
INTEREST_PAYABLE
Loan Portfolio
NUM_LOANS_OUTSTANDING
NUM_LOANS_PENDING_DISBURSAL
NUM_LOANS_IN_ARREARS
NUM_LOANS_AWAITING_APPROVAL
PORTFOLIO_PENDING_DISBURSAL
GROSS_LOAN_PORTFOLIO
AVERAGE_LOAN_BALANCE
TOTAL_DISBURSED_ACTIVE_LOANS
PROJECTED_LOAN_INTEREST_EARNINGS
Loan Transaction
TOTAL_LOANS_DISBURSED
Risk and Aging
PORTFOLIO_PERCENT_AT_RISK
PORTFOLIO_VALUE_AT_RISK
PAR_7_DAYS
PAR_15_DAYS
PAR_30_DAYS
PAR_90_DAYS
PAR_7_30_DAYS
PAR_30_90_DAYS
PAR_90_180_DAYS
PAR_180_360_DAYS
VAR_7_DAYS
VAR_15_DAYS
VAR_30_DAYS
VAR_90_DAYS
INTEREST_IN_SUSPENSE
Organization Indicators
"
NUM_BRANCHES
NUM_CREDIT_OFFICERS
NUM_LOANS_PER_BRANCH
NUM_LOANS_PER_CREDIT_OFFICER
NUM_LOAN_ACCOUNTS
NUM_USERS

Usage examples

//get a count of the number of clients in the system
    GET /api/indicators/NUM_CLIENTS

Samples responses:

//sample response of the number of clients
    {
    "NUM_CLIENTS":"100"
    }

support@mambu.com
https://cdn.desk.com/
false
desk
Loading
seconds ago
a minute ago
minutes ago
an hour ago
hours ago
a day ago
days ago
about
false
Invalid characters found
/customer/en/portal/articles/autocomplete