Bulk Report
This endpoint allows to generate multiple reports to be generated in one request. Just add the type parameter to the specific report-request and combine all requests into one bulk request.
URL and Request Body Structure of an Bulk Report
POST /insights/v1/reports/bulk/create HTTP/1.1
Content-Type: application/json; charset=utf-8
Authorization: Token <Token>
Host: <Host>
{
"reports": [
{
"type" : Enum<'ACCOUNT_INFOS', 'BALANCE_OVER_TIME', 'BALANCES', 'CATEGORIZED_TRANSACTIONS', 'EXPENSE_CATEGORIES', 'GROUP_BY_CATEGORY', 'RECURRING_TRANSACTIONS'>,
"...": "..."
}
]
}
This parameter determines the report to be generated. It needs to be added to the parameters of each report.
Further details about the ACCOUNT_INFOS, BALANCE_OVER_TIME, BALANCES, CATEGORIZED_TRANSACTIONS, EXPENSE_CATEGORIES(deprecated), GROUP_BY_CATEGORY and RECURRING_TRANSACTIONS reports are available on their respective detail page.
All other parameters are depending on the report. Please find details for each report at the respective detail pages.
Response Structure of a Bulk Report
{
"data": {
"reports": Array<Array<ReportResult>>
}
}
A list of report responses for each requested report. Each response again contains a list, since each report can have multiple reports depending on the requested parameters. The actual reports generated for this account in the requested order. Since the response structure varies for each report it will be described in their respective report documentation. Find the details here:
Example simple bulk request
This example is requesting two reports for all accounts of a customer. This customer only has one account.
{
"reports": [
{
"type": "BALANCES",
"insights_consumer_id": "SampleCustomer",
},
{
"type": "ACCOUNT_INFOS",
"insights_consumer_id": "SampleCustomer",
}
]
}
Example simple bulk response
{
"data": {
"reports": [
[
{
"type": "ACCOUNT_INFOS",
"insights_consumer_id": "SampleCustomer",
"insights_account_ids": [
"35a50677-c1df-4409-8159-e16b05c1772c"
],
"account_alias": "Girokonto(KarlMustermann)",
"holder_name": "Karl Mustermann",
"currency": "EUR",
"country": "DE",
"iban": "DE06000000000023456789",
"bic": "SFRTDE20XXX",
"account_type": "DEFAULT",
"transfer_type": "FULL",
"refreshed_at": "2021-06-15T09:22:02.523Z"
}
],
[
{
"type": "BALANCES",
"insights_consumer_id": "SampleCustomer",
"insights_account_ids": [
"35a50677-c1df-4409-8159-e16b05c1772c"
],
"refreshed_at": "2021-06-15T09:22:02.523Z",
"balance": {
"amount": 100000,
"currency": "EUR"
},
"available": {
"amount": 120000,
"currency": "EUR"
}
}
]
]
}
}
Example more detailed bulk request
This example is requesting two different reports for specific accounts of a customer, which has three different accounts.
{
"reports": [
{
"type": "ACCOUNT_INFOS",
"insights_consumer_id": "AnotherCustomer",
"exclude_insights_account_ids": [
"3b3d678f-66b7-4b23-a2a5-0bfd275e86a1","e6c4c735-06ec-47f1-b80d-55f68bb436b2"
]
},
{
"type": "BALANCES",
"insights_consumer_id": "AnotherCustomer",
"exclude_insights_account_ids": [
"3b3d678f-66b7-4b23-a2a5-0bfd275e86a1"
]
},
{
"type": "GROUP_BY_CATEGORY",
"insights_consumer_id": "AnotherCustomer",
"insights_account_ids": [
"3b3d678f-66b7-4b23-a2a5-0bfd275e86a1"
],
"from_date": "2021-05-21",
"to_date": "2021-06-14"
}
]
}
Example more detailed bulk response
{
"data": {
"reports": [
[
{
"type": "ACCOUNT_INFOS",
"insights_consumer_id": "AnotherCustomer",
"insights_account_ids": [
"23361ef5-f97c-489d-89d4-7f1f88a81884"
],
"account_alias": "Tagesgeld(KarlMustermann)",
"currency": "EUR",
"iban": "DE06000000000023459876",
"bic": "SFRTDE20XXX",
"account_type": "DEFAULT",
"refreshed_at": "2021-06-15T09:22:02.523Z"
}
],
[
{
"type": "BALANCES",
"insights_consumer_id": "AnotherCustomer",
"insights_account_ids": [
"23361ef5-f97c-489d-89d4-7f1f88a81884"
],
"refreshed_at": "2021-06-15T09:22:02.523Z",
"balance": {
"amount": 15400,
"currency": "EUR"
},
"available": {
"amount": 20000,
"currency": "EUR"
}
},
{
"type": "BALANCES",
"insights_consumer_id": "AnotherCustomer",
"insights_account_ids": [
"e6c4c735-06ec-47f1-b80d-55f68bb436b2"
],
"refreshed_at": "2021-06-15T09:22:02.523Z",
"balance": {
"amount": 0,
"currency": "EUR"
},
"available": {
"amount": 0,
"currency": "EUR"
}
}
],
[
{
"type": "GROUP_BY_CATEGORY",
"insights_consumer_id": "AnotherCustomer",
"insights_account_ids": [
"3b3d678f-66b7-4b23-a2a5-0bfd275e86a1"
],
"refreshed_at": "2021-06-15T09:22:02.523Z",
"categories": [
{
"id": "0723e731-132d-4f00-a655-d9768dddc9b3",
"name": "Groceries",
"total_count": 3,
"total_amount_sum": {
"amount": -456789,
"currency": "EUR"
},
"credit_count": 0,
"credit_amount_sum": {
"amount": 0,
"currency": "EUR"
},
"debit_count": 3,
"debit_amount_sum": {
"amount": 456789,
"currency": "EUR"
}
}
],
"from_date": "2021-05-21",
"to_date": "2021-06-14"
}
]
]
}
}