Modular Report Creation

[deprecated] Please see our report generation as described here.

The modular report creation is used to combine multiple report modules into one report. Each of these report modules can provide 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: Token <Token>
Host: <Host>
{
    "insights_consumer_id": String,
    "insights_account_ids": ?Array<String>,
    "excluded_insights_account_ids": ?Array<String>,
    "report_days": ?Integer,
    "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). The insights_account_ids parameter must be empty if the excluded_insights_account_ids parameter is set.

excluded_insights_account_ids String[], optional

The list of insights_account_ids which will be excluded from the report generation. The excluded_insights_account_ids parameter must be empty if the insights_account_ids parameter is set.

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.

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.

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<'ACCOUNT_INFOS', 'BALANCE_OVER_TIME', 'BALANCES', 'CATEGORIZED_TRANSACTIONSV2', 'EXPENSE_CATEGORIES', 'RECURRING_TRANSACTIONS'>
    "options": ?ReportOptions
}

type Enum, required

This parameter determines the report to be generated. Further details about the ACCOUNT_INFOS, BALANCE_OVER_TIME, BALANCES, CATEGORIZED_TRANSACTIONSV2, EXPENSE_CATEGORIES and RECURRING_TRANSACTIONS report are available 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 (String: "YYYY-MM-DDThh:mm:ss.sssZ), always present

The refreshed_at shows when the data for this account were last refreshed.

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. Find the details here:

results matching ""

    No results matching ""