FireFly III icon

FireFly III

Read, update, write and delete data using the powerful FireFly III API

Actions89

General → Insights

AI-generated

Overview

This node operation fetches financial insights from the FireFly III API. It allows users to retrieve summarized data about expenses, income, or transfers, grouped by various categories such as asset, expense, revenue, category, tag, budget, or bill. Users can filter insights by date range and specify account, category, tag, budget, and bill IDs to narrow down the data. This operation is useful for financial analysis, budgeting, and reporting to understand transaction patterns and financial health.

Use Case Examples

  1. A user wants to get insights on their expenses grouped by category for the last month to analyze spending habits.
  2. A financial analyst needs to retrieve income insights grouped by revenue accounts for a specific date range to prepare a report.
  3. A budget manager wants to see transfer insights grouped by budget to monitor fund allocations.

Properties

Name Meaning
X-Trace-ID A unique UUID identifier for the request, used for debugging and tracing.
Insights On The type of transaction to get insights on, such as expenses, income, or transfers.
Group By The grouping criteria for the insights, such as asset account, expense account, revenue account, category, tag, budget, or bill.
Date Range Filters Filters to specify the start and end dates for the insights data.
Account IDs Comma-separated list of account IDs to filter the insights.
Category IDs Comma-separated list of category IDs to filter the insights (only applicable when grouping by category).
Tag IDs Comma-separated list of tag IDs to filter the insights (only applicable when grouping by tag).
Budget IDs Comma-separated list of budget IDs to filter the insights (only applicable when grouping by budget).
Bill IDs Comma-separated list of bill IDs to filter the insights (only applicable when grouping by bill).

Output

JSON

  • json - The JSON response from the FireFly III API containing the requested insights data.

Dependencies

  • FireFly III API
  • An API key credential for authentication

Troubleshooting

  • Ensure the date range filters are correctly formatted as YYYY-MM-DD to avoid API errors.
  • Verify that the account, category, tag, budget, and bill IDs provided are valid and exist in the FireFly III system.
  • Check the API documentation for compatibility of group by options with the selected transaction type, as some groupings may not work with all transaction types.
  • If the X-Trace-ID is used, ensure it is a valid UUID to help with debugging and tracing requests.

Links

Discussion