--- title: "Get Bank Statement Analytics" method: GET path: "/api/v1/mew/usbs-analytics/{doc_id}/" tags: ["Analytics"] --- # Get Bank Statement Analytics `GET /api/v1/mew/usbs-analytics/{doc_id}/` Retrieve detailed analytics for a processed bank statement document. The metrics provide insights into spending habits, cash flow, and other financial patterns based on the document's content. ## Path parameters - `doc_id` string, required ## Query parameters - `output` 'json' | 'csv' | 'xlsx' - `mode` 'basic' | 'all' ## Headers - `apikey` string, required - `content-type` 'application/json', required ## Response `200` OK - InlineResponse2008 - `abnormal_transactions_analytics` InlineResponse2008AbnormalTransactionsAnalytics — Analytics for transactions with amounts considered abnormally high, broken down by daily, weekly, or monthly periods. - `daily_analytics` InlineResponse2008AbnormalTransactionsAnalyticsDailyAnalytics — Details of daily transactions with amounts considered abnormally high (e.g., exceeding 50% of the median transaction amount). - `count` integer — The count of days with transactions having abnormal amounts. - `transactions` unknown[] - unknown - `account_info` InlineResponse2008AccountInfo — Basic account information extracted from the document. - `account_address` string — The account holder's address as extracted from the bank statement. - `account_name` string — The name of the account holder from the bank statement. - `account_number` string — The account number as extracted from the bank statement. - `account_type` string — The type of account (e.g., SAVING, CHECKING). - `bank_name` string — The name of the bank as extracted from the bank statement. - `closing_balance` string — The closing balance amount from the bank statement. - `end_date` string — The end date of the statement period. - `opening_balance` string — The opening balance amount from the bank statement. - `start_date` string — The start date of the statement period. - `active_dates` InlineResponse2008ActiveDates — Analysis of the statement's time period and transaction activity. - `active_days` integer — The total number of unique days on which transactions occurred. - `total_days` integer — The total number of days in the statement period (from start date to end date). - `affordability_analysis` InlineResponse2008AffordabilityAnalysis — Analysis of spending in discretionary categories like Groceries, Gas, Restaurants, etc. - `average_affordability` number - `average_monthly_income` InlineResponse2008AverageMonthlyIncome — Analysis of monthly income transactions. - `amounts` number[] — A list of all income transaction amounts (e.g., Salary, Wage). - `average_transaction_amount` number — The average amount of an income transaction. - `max_amount` number — The largest single income transaction amount. - `min_amount` number — The smallest single income transaction amount. - `monthly_analytics` object — Month-specific income analysis. - `monthly_income` object - `months` string[] - `total_amount` number - `balance_growth` InlineResponse2008BalanceGrowth — Analysis of the account balance over the statement period. - `balances_analysis` InlineResponse2008BalanceGrowthBalancesAnalysis - `avg_daily_balances` object — The average daily balance for each day with transaction activity. - `growth_percent` InlineResponse2008BalanceGrowthBalancesAnalysisGrowthPercent — Percentage growth of the account balance over time. - `daily_balance_growth` object — The percentage growth in balance on a day-to-day basis. - `monthly_balance_growth` object — The percentage growth in balance on a month-to-month basis. - `monthly_balances` object — A list of balance amounts for each month. - `basic_metrics` InlineResponse2008BasicMetrics — Key metrics summarizing the transactions in the bank statement. - `average_amount` number — The average amount of all transactions in the statement. - `average_daily_balance` number — The average daily balance across the entire statement period. - `average_weekday_balance` number — The average balance on weekdays. - `max_credit` number — The largest single credit transaction amount. - `max_debit` number — The largest single debit transaction amount. - `nsf_fees_count` integer — The number of non-sufficient fund (NSF) fees identified. - `overdraft_fees_count` integer — The number of overdraft fees identified. - `total_expense` number — The total amount of all expense-categorized transactions. - `total_income` number — The total amount of all income-categorized transactions. - `category_based_analytics` object — A breakdown of transaction analytics by category. - `days_with_negative_balance` InlineResponse2008DaysWithNegativeBalance — Analysis of transactions resulting in a negative account balance. - `count` integer — The number of days the account had a negative balance. - `transactions` InlineResponse2008DaysWithNegativeBalanceTransactions[] — A list of transactions that resulted in a negative balance. - `amount` number — The amount of the transaction that resulted in a negative balance. - `balance` number — The resulting negative balance. - `date` string — The date of the transaction. - `debt_coverage_ratio` InlineResponse2008DebtCoverageRatio — The debt coverage ratio analysis. - `debt_coverage_ratio` InlineResponse2008DebtCoverageRatioDebtCoverageRatio - `label` string - `value` number — The debt-to-income ratio, calculated by dividing total debt payments by total income. - `expenditure_income_analysis` InlineResponse2008ExpenditureIncomeAnalysis — A comparative analysis of income versus expenditure. - `expenditure_analysis` InlineResponse2008ExpenditureIncomeAnalysisExpenditureAnalysis — Detailed analysis of expenditure transactions. - `amounts` number[] — A list of all expense transaction amounts. - `average_transaction_amount` number — The average amount of an expense transaction. - `credit` object — Analysis of credit transactions categorized as expenditures. - `debit` object — Analysis of debit transactions categorized as expenditures. - `max_amount` number — The largest single expense transaction amount. - `min_amount` number — The smallest single expense transaction amount. - `total_amount` number — The total amount of all expense transactions. - `income_analysis` InlineResponse2008ExpenditureIncomeAnalysisIncomeAnalysis — Detailed analysis of income transactions. - `amounts` number[] — A list of all income transaction amounts. - `average_transaction_amount` number — The average amount of an income transaction. - `credit` object — Analysis of credit transactions categorized as income. - `debit` object — Analysis of debit transactions categorized as income. - `max_amount` number — The largest single income transaction amount. - `min_amount` number — The smallest single income transaction amount. - `total_amount` number — The total amount of all income transactions. - `is_expenses_greater_than_income` boolean — A flag indicating if total expenses exceed total income. - `fixed_cost` InlineResponse2008FixedCost — Analysis of transactions categorized as fixed costs (e.g., rent, loan payments, subscriptions). - `amounts` number[] — A list of transaction amounts categorized as fixed costs. - `average_transaction_amount` number — The average amount of a fixed cost transaction. - `max_amount` number — The maximum amount of a fixed cost transaction. - `min_amount` number — The minimum amount of a fixed cost transaction. - `total_amount` number — The total amount of all fixed cost transactions. - `non_sufficient_funds_analytics` InlineResponse2008NonSufficientFundsAnalytics — Analysis of non-sufficient funds transactions. - `count` integer — The total count of non-sufficient funds (NSF) transactions. - `quarterly_analytics` InlineResponse2008QuarterlyAnalytics — A quarter-by-quarter (3-month period) analysis of transactions. - `quarter` InlineResponse2008QuarterlyAnalyticsQuarter — Analysis for a specific quarter. - `average_transaction_amount` number — The average transaction amount within this quarter. - `months` string[] — The months included in this quarter's analysis. - `total_amount` number — The total transaction amount for this quarter. - `total_credit` number — The total credit amount for this quarter. - `total_debit` number — The total debit amount for this quarter. - `spend_by_merchant` object — A merchant-specific analysis of transactions from the bank statement document. - `total_expenses` number — The total amount of all transactions categorized as expenses. ## Other responses - `401` — Unauthorized - `404` — Not Found - `500` — Processing Error --- [API](https://skmtc.dev/docsumo/apis/docsumo-api.md) · [All operations](https://skmtc.dev/docsumo/apis/docsumo-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/docsumo/docsumo-api/revisions/b29ba62ebe9b/schema)