1. API Reference Guide
  2. Segment Metrics

8 Segment Metrics

Endpoint (HTTP Link): http://<hostname>:<port>/rest-api /rest-v1/segmentMetrics/

Service Type: POST

Request JSON Prameters:

  • portfolio_code

    String

    Refers to the Code for the Portfolio: Portfolio being that of Retail or Institutional.

  • segment_type_code

    String

    Refers to the Code for Segment Type : Segment Type being Demographic/Risk Based/Profitability/Behavioral, and so on.

  • segment_code

    String

    Refers to the Code for Segment within a particular Segment Type.

Request JSON Sample:
{
"items": [
{
"portfolio_code": "string",
"segment_type_code": "string",
"segment_code": "string",
}
]
}

Response Parameters:

  • portfolio_code

    String

    Refers to the Code for the Portfolio: Portfolio being that of Retail or Institutional.

  • segment_type_code

    String

    Refers to the Code for Segment Type : Segment Type being Demographic/Risk Based/Profitability/Behavioral, and so on.

  • segment_code

    String

    Refers to the Code for Segment within a particular Segment Type.

  • rota

    Number

    Return On Total Assets.

  • raroc

    Number

    Risk Adjusted Return On Capital.

  • roe

    Number

    Return On Equity.

  • total_income

    Number

    Total income.

  • total_expenses

    Number

    Total expenses.

  • net_income

    Number

    Net income.

Response JSON Sample:
{
"items": [
{
"portfolio_code": "string",
"segment_type_code": "string",
"segment_code": "string",
"rota": 0,
"raroc": 0,
"roe": 0,
"total_income": 0,
"total_expenses": 0,
"net_income": 0
}
]
}