Sign in

v50

latestOpenAPI 3.0.0raw.githubusercontent.com2026-07-27107348584.3 KB
Insights

List insights

List insights from data sources.

get/insights

Query parameters

sizeinteger
Example:50

The number of objects you want returned in a collection.

cursorstring

Uses the filter values of the previous page to determine the next set of items.

userIdstring

Filter to those associated with a particular user ID.

sourceIdstring

Filter to those associated with a particular source ID. If we query the link account data, the sourceId is the accountId, If we query the archive data, then the sourceId is the archiveId

Response

List Insights Response

code'OK' | 'CREATED' | 'INVALID_CREDENTIALS' | 'INVALID_PARAMETERS' | 'INVALID_TOKEN' | 'UNAUTHORIZED_ACCESS' | 'MISSING_RESOURCE' | 'REQUEST_LIMIT_EXCEEDED' | 'SERVER_ERROR' | 'UNSUPPORTED_METHOD' | 'SERVER_UNAVAILABLE' | 'TIME_LIMIT_EXCEEDED' required

Request status code

messagestring

Message response to the request

requestIdstring required

Unique ID that is added to the body of every response for easy traceability of the request in our logs.

Example response

{
  "code": "OK",
  "message": "Success",
  "requestId": "5b79399a-6852-4234-bb0e-ad472648282d",
  "data": {
    "nextCursor": "1259723474",
    "items": [
      {
        "id": "insight-123456789012345678901234567890",
        "cutoffTime": "2021-04-14T09:30:24Z",
        "features": {
          "incomes_count": 9,
          "incomes_first_income_month_range": -999,
          "incomes_missing_month_max": -999,
          "incomes_missing_month_count": -999,
          "incomes_amount_sum": -999,
          "incomes_amount_average": 1100,
          "incomes_amount_min": 1000,
          "incomes_amount_max": 1200,
          "incomes_amount_median": 1200,
          "incomes_amount_std": 1000,
          "incomes_last3_months_amount_sum": 6000,
          "incomes_last3_months_amount_average": 1100,
          "incomes_last3_months_amount_min": 1000,
          "incomes_last3_months_amount_max": 1200,
          "incomes_last3_months_amount_median": 1200,
          "incomes_last3_months_amount_std": 1000,
          "incomes_last6_months_amount_sum": 6000,
          "incomes_last6_months_amount_average": 1100,
          "incomes_last6_months_amount_min": 1000,
          "incomes_last6_months_amount_max": 1200,
          "incomes_last6_months_amount_median": 1200,
          "incomes_last6_months_amount_std": 1000,
          "incomes_last9_months_amount_sum": 6000,
          "incomes_last9_months_amount_average": 1100,
          "incomes_last9_months_amount_min": 1000,
          "incomes_last9_months_amount_max": 1200,
          "incomes_last9_months_amount_median": 1200,
          "incomes_last9_months_amount_std": 1000,
          "incomes_last12_months_amount_sum": 6000,
          "incomes_last12_months_amount_average": 1100,
          "incomes_last12_months_amount_min": 1000,
          "incomes_last12_months_amount_max": 1200,
          "incomes_last12_months_amount_median": 1200,
          "incomes_last12_months_amount_std": 1000,
          "incomes_last18_months_amount_sum": 6000,
          "incomes_last18_months_amount_average": 1100,
          "incomes_last18_months_amount_min": 1000,
          "incomes_last18_months_amount_max": 1200,
          "incomes_last18_months_amount_median": 1200,
          "incomes_last18_months_amount_std": 1000,
          "incomes_last18_months_max_amount_count": 1000,
          "incomes_starting_amount": 1000,
          "incomes_current_amount": 1000,
          "incomes_latest_growth": 1000,
          "liabilities_loan_count": 1000,
          "liabilities_loan_amount_min": 1000,
          "liabilities_loan_amount_max": 1000,
          "liabilities_loan_amount_total": 1000,
          "liabilities_loan_amount_average": 1000,
          "liabilities_loan_amount_std": 1000,
          "liabilities_finished_loan_count": 1000,
          "liabilities_outstanding_loan_count": 10,
          "liabilities_outstanding_amount_max": 1000,
          "liabilities_outstanding_amount_total": 1000,
          "liabilities_outstanding_amount_average": 1000,
          "liabilities_overdue_loan_count": 10,
          "liabilities_overdue_amount_total": 1000,
          "liabilities_overdue_amount_average": 1000,
          "liabilities_ongoing_amortization_amount_sum": 1000,
          "liabilities_ongoing_amortization_amount_min": 1000,
          "liabilities_ongoing_amortization_amount_max": 1000,
          "liabilities_ongoing_amortization_amount_average": 1000,
          "liabilities_ongoing_amortization_amount_median": 1000,
          "liabilities_ongoing_amortization_amount_std": 1000,
          "liabilities_payment_count": 10,
          "liabilities_payment_amount_max": 1000,
          "liabilities_payment_amount_min": 1000,
          "liabilities_payment_amount_median": 1000,
          "liabilities_payment_amount_average": 1000,
          "liabilities_payment_amount_sum": 1000,
          "liabilities_payment_amount_std": 1000,
          "employments_current_status": "EMPLOYED",
          "employments_employer_count": 3,
          "employments_current_tenure": 5,
          "identity_age": 30,
          "link_days_since_first": 130,
          "link_days_since_last": 2,
          "link_day3_count": 2,
          "link_day7_count": 5,
          "link_day30_count": 8,
          "link_day90_count": 12,
          "link_day180_count": 12,
          "link_day365_count": 12,
          "link_day730_count": 12
        },
        "metadata": {
          "itemCreatedAt": "2021-04-14T09:30:24Z",
          "createdAt": "2021-04-14T09:30:24Z",
          "sourceType": "Account"
        }
      }
    ]
  }
}