SIsivo
Debt Lines

Get debt line monthly metrics

Changed on
get/debt-lines/{id}/metrics

Request

Path parameters

idstring required

An object id with prefix

Example:user_0123456789ABCDEFGHIJKLMNOPq

Query parameters

limitinteger

Maximum number of results to return, from 1 to 100; defaults to 25

pagestring

Opaque page token from a previous response's next_page or previous_page; pass it back unchanged, with the same sort and filters

expandstring[]

Extra fields to include in the page; total_count counts the matching results, exactly up to 10000

sort'test_month_desc'

Result order; defaults to test_month_desc

test_monthstring

Only return metrics computed for this month

Example:2024-01

Response

Successful operation

has_moreboolean required

Whether more results follow this page in the list order

next_pagestring nullable required

Token for the page after this one, or null when this is the last page

previous_pagestring nullable required

Token for the page before this one, or null when this is the first page

total_countinteger

Number of results matching the filters, exact up to 10000; 10001 means more than that. Only present when the request expands total_count

Example response

{
  "data": [
    {
      "id": "user_0123456789ABCDEFGHIJKLMNOPq",
      "debt_line_id": "user_0123456789ABCDEFGHIJKLMNOPq",
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:30:00Z",
      "test_month": "2024-01",
      "outstanding_balance": 10000,
      "pledged_balance": 10000,
      "eligible_balance": 10000,
      "effective_apr": 0.05,
      "default_rate": 0.05,
      "utilization_rate": 0.05,
      "concentration": 0.05,
      "cashflow_covering_ratio": 0.05,
      "top_balances_eligible": [
        10000
      ],
      "top_balances_all": [
        10000
      ],
      "report_delay": 42
    }
  ]
}

Changes