--- title: "List insights" method: GET path: "/insights" tags: ["Insights"] --- # List insights `GET /insights` List insights from data sources. ## Query parameters - `size` integer - `cursor` string - `userId` string - `sourceId` string ## Response `200` List Insights Response - InsightListResponse - `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 - `message` string — Message response to the request - `requestId` string, required — Unique ID that is added to the body of every response for easy traceability of the request in our logs. - `data` object - `nextCursor` string — The next cursor value that can be used in the following query. - `items` Insight[] - `id` string, required - `cutoffTime` string, date-time, required — Date and time - `features` ObjectFeature, required - `incomes_count` integer — The quantity of the estimated incomes - `incomes_first_income_month_range` integer — Calculate the interval from the first income record time to the current time by month - `incomes_missing_month_max` integer — From all estimated incomes, calculate the number of months between the last payment month and the next payment month, and then take the maximum value - `incomes_missing_month_count` integer — From all estimated incomes, calculate the months diff between current income month and the before income month, and count if the diff > 1 - `incomes_amount_sum` number — From all estimated incomes, calculate the total of the amount - `incomes_amount_average` number — From all estimated incomes, calculate the average amount of the total amount - `incomes_amount_min` number — From all estimated incomes, get the minimum amount - `incomes_amount_max` number — From all estimated incomes, get the maximum amount - `incomes_amount_median` number — From all estimated incomes, get the median amount - `incomes_amount_std` number — From all estimated incomes, get the median amount - `incomes_last3_months_amount_sum` number — From all estimated incomes in last 3 months, calculate the total of the amount - `incomes_last3_months_amount_average` number — From all estimated incomes in last 3 months, calculate the average amount of the total amount - `incomes_last3_months_amount_min` number — From all estimated incomes in last 3 months, get the minimum amount - `incomes_last3_months_amount_max` number — From all estimated incomes in last 3 months, get the maximum amount - `incomes_last3_months_amount_median` number — From all estimated incomes in last 3 months, get the median amount - `incomes_last3_months_amount_std` number — From all estimated incomes in last 3 months, get the standard deviation of the amount - `incomes_last6_months_amount_sum` number — From all estimated incomes in last 6 months, calculate the total of the amount - `incomes_last6_months_amount_average` number — From all estimated incomes in last 6 months, calculate the average amount of the total amount - `incomes_last6_months_amount_min` number — From all estimated incomes in last 6 months, get the minimum amount - `incomes_last6_months_amount_max` number — From all estimated incomes in last 6 months, get the maximum amount - `incomes_last6_months_amount_median` number — From all estimated incomes in last 6 months, get the median amount - `incomes_last6_months_amount_std` number — From all estimated incomes in last 6 months, get the standard deviation of the amount - `incomes_last9_months_amount_sum` number — From all estimated incomes in last 9 months, calculate the total of the amount - `incomes_last9_months_amount_average` number — From all estimated incomes in last 9 months, calculate the average amount of the total amount - `incomes_last9_months_amount_min` number — From all estimated incomes in last 9 months, get the minimum amount - `incomes_last9_months_amount_max` number — From all estimated incomes in last 9 months, get the maximum amount - `incomes_last9_months_amount_median` number — From all estimated incomes in last 9 months, get the median amount - `incomes_last9_months_amount_std` number — From all estimated incomes in last 9 months, get the standard deviation of the amount - `incomes_last12_months_amount_sum` number — From all estimated incomes in last 12 months, calculate the total of the amount - `incomes_last12_months_amount_average` number — From all estimated incomes in last 12 months, calculate the average amount of the total amount - `incomes_last12_months_amount_min` number — From all estimated incomes in last 12 months, get the minimum amount - `incomes_last12_months_amount_max` number — From all estimated incomes in last 12 months, get the maximum amount - `incomes_last12_months_amount_median` number — From all estimated incomes in last 12 months, get the median amount - `incomes_last12_months_amount_std` number — From all estimated incomes in last 12 months, get the standard deviation of the amount - `incomes_last18_months_amount_sum` number — From all estimated incomes in last 18 months, calculate the total of the amount - `incomes_last18_months_amount_average` number — From all estimated incomes in last 18 months, calculate the average amount of the total amount - `incomes_last18_months_amount_min` number — From all estimated incomes in last 18 months, get the minimum amount - `incomes_last18_months_amount_max` number — From all estimated incomes in last 18 months, get the maximum amount - `incomes_last18_months_amount_median` number — From all estimated incomes in last 18 months, get the median amount - `incomes_last18_months_amount_std` number — From all estimated incomes in last 18 months, get the standard deviation of the amount - `incomes_last18_months_max_amount_count` number — From all estimated incomes in last 18 months, find the maximum amount, and count the number of monthly income equal to the maximum amount - `incomes_starting_amount` number — the estimated income from when the user has started earning income - `incomes_current_amount` number — the amount from the latetest one record - `incomes_latest_growth` number — For the latetest one record, calculate the growth of income from the same month last year - `liabilities_loan_count` integer — For the latetest one record, calculate the count of records - `liabilities_loan_amount_min` number — From all liabilities, calculate the minimum of the amount - `liabilities_loan_amount_max` number — From all liabilities, calculate the maximum of the amount - `liabilities_loan_amount_total` number — From all liabilities, calculate the total of the amount - `liabilities_loan_amount_average` number — From all liabilities, calculate the average of the amount - `liabilities_loan_amount_std` number — From all liabilities, calculate the standard deviation of the amount - `liabilities_finished_loan_count` number — From all liabilities that outstandingBalance <= 0, calculate the count of the records - `liabilities_outstanding_loan_count` integer — From all liabilities that outstandingBalance > 0, calculate the count of the records - `liabilities_outstanding_amount_max` number — From all liabilities that outstandingBalance > 0, calculate the count of the records - `liabilities_outstanding_amount_total` number — From all liabilities that outstandingBalance > 0, calculate the total of the amount - `liabilities_outstanding_amount_average` number — From all liabilities that outstandingBalance > 0, calculate the average of the amount - `liabilities_overdue_loan_count` integer — From all liabilities that overduePaymentAmount > 0, calculate the count of the records - `liabilities_overdue_amount_total` number — From all liabilities that overduePaymentAmount > 0, calculate the total of the amount - `liabilities_overdue_amount_average` number — From all liabilities that overduePaymentAmount > 0, calculate the average of the amount - `liabilities_ongoing_amortization_amount_sum` number — Sum of all amortization amounts for ongoing/current liabilities (not yet fully paid off) - `liabilities_ongoing_amortization_amount_min` number — Smallest of all amortization amounts for ongoing/current liabilities (not yet fully paid off) - `liabilities_ongoing_amortization_amount_max` number — Largest of all amortization amounts for ongoing/current liabilities (not yet fully paid off) - `liabilities_ongoing_amortization_amount_average` number — Average of all amortization amounts for ongoing/current liabilities (not yet fully paid off) - `liabilities_ongoing_amortization_amount_median` number — Median of all amortization amounts for ongoing/current liabilities (not yet fully paid off) - `liabilities_ongoing_amortization_amount_std` number — Standard deviation of all amortization amounts for ongoing/current liabilities (not yet fully paid off) - `liabilities_payment_count` number — Quantity of liability payments made (across all liability records) - `liabilities_payment_amount_max` number — Largest amount of payments made for liabilities (across all liability records). - `liabilities_payment_amount_min` number — Smallest amount of payments made for liabilities (across all liability records). - `liabilities_payment_amount_median` number — Median amount of payments made for liabilities (across all liability records). - `liabilities_payment_amount_average` number — Average amount of payments made for liabilities (across all liability records). - `liabilities_payment_amount_sum` number — Total amount of payments made for liabilities (across all liability records). - `liabilities_payment_amount_std` number — Standard deviation of payments made for liabilities (across all liability records). - `employments_current_status` string — The user's current employment status, may be one of: EMPLOYED, GIG (for gig economy workers), or UNEMPLOYED - `employments_employer_count` integer — Quantity of unique employers - `employments_current_tenure` integer — Quantity of months at current employer - `identity_age` integer — Age of the user based on date of birth - `link_days_since_first` integer — Number of days since the first account connection, if MAW is enabled. - `link_days_since_last` integer — Number of days since the last account connection, if MAW is enabled. - `link_day3_count` integer — Number of tenants this account has connected to in the last 3 days, if MAW is enabled. - `link_day7_count` integer — Number of tenants this account has connected to in the last 7 days, if MAW is enabled. - `link_day30_count` integer — Number of tenants this account has connected to in the last 30 days, if MAW is enabled. - `link_day90_count` integer — Number of tenants this account has connected to in the last 90 days, if MAW is enabled. - `link_day180_count` integer — Number of tenants this account has connected to in the last 180 days, if MAW is enabled. - `link_day365_count` integer — Number of tenants this account has connected to in the last 365 days, if MAW is enabled. - `link_day730_count` integer — Number of tenants this account has connected to in the last 730 days, if MAW is enabled. - `metadata` ObjectReferenceMetadata — Metadata related to account-specific data - `itemCreatedAt` string, date-time, required — Date and time - `createdAt` string, date-time, required — Date and time - `accountId` string — The accountId of this object - `sourceId` string, required — The ACCOUNT or ARCHIVE ID associated with this object - `sourceType` 'ACCOUNT' | 'UPLOAD' | 'ARCHIVE' | 'SOCIAL_SECURITY', nullable, required — Source Type - `userId` string, required — The user ID associated with this object - `providerId` string, required — The provider ID associated with this object --- [API](https://skmtc.dev/smileapi/apis/smile-api.md) · [All operations](https://skmtc.dev/smileapi/apis/smile-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/smileapi/smile-api/revisions/a4930eb49f4d/schema)