Data Summary
Summary
The Data Summary is a powerful tool designed to give users a detailed overview of their data, with various metrics categorized according to different criteria within a defined date range. Two types of summary reports are available:
- Accounts Summary: This report organizes data by individual accounts, providing a detailed breakdown of the financial activity associated with each account.
- Owner Summary: This report aggregates data from all accounts and categorizes it by currency. Data for each currency can be further segmented by month within the specified time period.
Additionally, if you use the Labeling service, the Data Summary allows you to analyze transactions containing specific labels or a set of labels, enhancing the level of detail in your data analysis.
Data Summary content
The Data Summary provides a comprehensive look at the financial activity of individual accounts or account owners over a specified time period. It aggregates various metrics, offering valuable insights into account behavior, transaction patterns, balances, and more. Below are key elements that may be included:
- Transaction Overview
This includes information such as the total number of transactions, their total value, and average value. The summary can also categorize transactions by type (incoming or outgoing) and by specific labels, such as healthcare or loan payments, if applicable. - Account Balances
The summary provides details about the current balances of each account, including average balance over a defined period and per-transaction balances. - Account Activity
Key metrics here include the total number of active days within the selected time range and the first date of activity. - Transaction Labels
If you are using a Labeling service, transactions can be filtered and categorized by specific labels. For example, you can examine transactions categorized as healthcare, utilities, or loans. - Owner Information
For accounts linked to specific individuals, the summary may include owner details such as names and addresses (when available). - Account Details
The Data Summary includes account details, such as IBANs or bank(s) name.
Please note that the scope of data available depends on the endpoint used. For detailed information about the data available through specific endpoints, refer to the Data Summary section in our documentation.
Integration
To access the Data Summary, you can choose between two types of summary reports, available in both basic and month-divided versions:
Accounts Summary:
POST /v1/accounts-summary
POST /v1/accounts-summary-with-monthly
This report organizes data per account (IBAN). Each account object contains managed categories with their respective values. Additionally, in the accounts-summary-with-monthly
version, the IBAN object includes a monthly object. This object provides a breakdown of monthly summaries for each month within the requested time period.
Owner Summary:
POST /v1/owner-summary
POST /v1/owner-summary-with-monthly
This report organizes data per currency. Each currency object contains managed categories with their respective values. Additionally, in the owners-summary-with-monthly
version, the currency object includes a monthly object. This object provides a breakdown of monthly summaries for each month within the requested time period.
To determine the metrics to include in the summary, use the categories
parameter. A detailed description of the available values and their syntax can be found in the documentation.
In addition to the basic categories available, it is also possible to use Labels Query, which allows you to use the labels given by Kontomatik to create rules and analyze only selected sets of labels.
Like our other analytics services, Data Summary requires the ownerExternalId
as input, which allows it to generate a comprehensive summary using data from various sources and banks.
Responses returned from Data Summary are available in JSON format.
Labels Query
The Data Summary allows you to customize your report through the Labels Query feature, enabling you to focus on transactions that include specific labels assigned via the Labeling service.
With Labels Query, you can define categories that focus on transactions with specific labels. The query uses logical operators such as AND (&
), OR (|
), and NOT (~
) to include or exclude transactions based on the assigned labels, e.g.:
label:car
: Include transactions with the “car” label.label:car&leasing
: Include transactions that have both “car” and “leasing” labels.label:car|leasing
: Include transactions that have either the “car” or “leasing” label.label:car&leasing~invoice
: Include transactions with both “car” and “leasing” labels but exclude those with the “invoice” label.
The resulting calculation will appear as a custom category in your Data Summary response, displaying calculated metrics based on the specified labels.
For more detailed instructions and advanced examples, please refer to our User Guide - the Labels Query. If you need assistance in preparing a set of categories with conditions for labels, feel free to contact us.