Modular Report Creation

Build a report fit to consumer needs is possible using this endpoint. Here a report can be created by combining report modules containing different kind of data.

URL and Request Body Structure of a Report Creation call

POST /insights/v1/reports/create HTTP/1.1
Content-Type: application/json; charset=utf-8
Authorization: Bearer <Token>
Host: <Host>
{
    "insights_consumer_id": string,
    "insights_account_ids": ?Array<string>,
    "report_days": ?int,
    "from_date": ?Date,
    "to_date": ?Date,
    "reports": Array<ModularReport>
}

insights_consumer_id String, required

The insights_consumer_id parameter identifies the consumer whose transactions are used to generate the report.

insights_account_ids String[], optional

The list of accounts, identified by the insights_account_id, which will filter all transactions from the consumer to only those accounts. If missing all accounts of the insights_consumer_id will be used to generate the report(s).

report_days Integer, optional

This parameter offers to give a timeframe without need to calculate dates. If report_days provides a value, the parameters from_date and to_date will be derived from current day (today) minus the given number of days. The timeframe for which the report should be generated can be set by specifying either the from_date and to_date parameters or this report_days parameter. If no timeframe is specified, the default timeframe of the last 62 days will be used.

from_date Date (String: "YYYY-MM-DD"), optional

The from_date parameter (in combination with the to_date parameter) will be used as the start date for this timeframe. It has to be provided in the YYYY-MM-DD format according to ISO 8601.

The timeframe for which the report should be generated can be set by specifying either the from_date and to_date parameters or the report_days parameter. If no timeframe is specified, the default timeframe of the last 62 days will be used.

to_date Date (String: "YYYY-MM-DD"), optional

The to_date parameter (in combination with the from_date parameter) will be used as the end date for this timeframe. It has to be provided in the YYYY-MM-DD format according to ISO 8601.

The timeframe for which the report should be generated can be set by specifying either the from_date and to_date parameters or the report_days parameter. If no timeframe is specified, the default timeframe of the last 62 days will be used.

reports ModularReport[], required

Specify the reports to be generated. Depending on the report, some further options can be/need to be provided.

ModularReport

{
    "type" : enum<'CATEGORIZED_TRANSACTIONS', 'EXPENSE_CATEGORIES', 'BALANCE_OVER_TIME'>
    "options": ?ReportOptions
}

type Enum, required

This parameter determines the report to be generated. Further details about the CATEGORIZED_TRANSACTIONS, EXPENSE_CATEGORIES and BALANCE_OVER_TIME report are availabe on their detail page.

options ReportOptions, optional

This parameter depends on the report to be generated, some reports even do not need options. Find the description at the respective report description.

Response Structure of a Report Creation call

{
    "data": {
        "accounts": Array<AccountWithReports>
    }
}

accounts AccountWithReports[], always present

All reports are grouped by account. This list will contain each account requested (via the insights_account_ids) together with the report-data for this account.

AccountWithReports

{
    "insights_account_id":  string,
    "refreshed_at": DateTime,
    "reports": Array<ModularReports>
}

insights_account_id String, always present

The insights_account_id is used to identify a specific account within Account Insights.

refreshed_at DateTime, always present

The refreshed_at shows when the data for this account were last refreshed. It is provided in the YYYY-MM-DDThh:mm:ss.sssZ format according to ISO 8601 with an UTC offset, such as 2007-12-03T10:15:30.152Z.

reports ModularReports[], always present

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.

results matching ""

    No results matching ""