v1

latestOpenAPI 3.0.02026-07-263365159.1 KB

Analytics

Get Bank Statement Analytics

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.

get/api/v1/mew/usbs-analytics/{doc_id}/

Path parameters

doc_idstring required

The unique identifier of the bank statement document.

Query parameters

output'json' | 'csv' | 'xlsx'

Specify the desired output format for the analytics data. Defaults to json.

mode'basic' | 'all'

Specify the level of detail for the analytics. basic provides a summary, while all provides a more in-depth report. Defaults to basic.

Headers

apikeystring required

Your personal API key for authentication.

content-type'application/json' required

Must be application/json.

Response

category_based_analyticsobject

A breakdown of transaction analytics by category.

spend_by_merchantobject

A merchant-specific analysis of transactions from the bank statement document.

total_expensesnumber

The total amount of all transactions categorized as expenses.