Reportei icon

Reportei

Perform actions with Reportei API

Actions3

Overview

This node integrates with the Reportei API to create reports, dashboards, or timeline entries within a specified project. Specifically, for the Create a Report operation under the Report resource, it allows users to generate detailed analytical reports based on selected integrations and defined time periods.

Common scenarios where this node is beneficial include:

  • Automating the generation of performance or marketing reports for clients or projects.
  • Creating comparative analysis reports by specifying current and comparison date ranges.
  • Integrating report creation into larger workflows that gather data, analyze it, and then produce formatted reports automatically.

For example, a marketing team could use this node to automatically generate weekly performance reports for different campaigns by selecting relevant integrations (like social media platforms) and defining the analysis period.

Properties

Name Meaning
Project Name or ID Select the project in which the report will be created. You can choose from a list of projects or specify a project ID using an expression.
Integration Names or IDs Select one or more integrations to include in the report. The options depend on the chosen project and can be selected from a list or specified via expressions.
Title Define the main title of the report.
Subtitle Define a subtitle for the report to provide additional context or description.
Analysis Start Specify the start date and time for the analysis period covered by the report.
Analysis End Specify the end date and time for the analysis period covered by the report.
Comparison Period Start Specify the start date and time for the comparison period, allowing side-by-side analysis with the main analysis period.
Comparison Period End Specify the end date and time for the comparison period.

Output

The node outputs JSON data representing the response from the Reportei API after creating the report. This typically includes details about the newly created report such as its ID, title, status, and any other metadata returned by the API.

If no valid operation is performed, the output JSON contains a message indicating so.

The node does not output binary data.

Example output structure (simplified):

{
  "id": "report_id",
  "title": "Report Title",
  "status": "created",
  "other_metadata": "..."
}

Dependencies

  • Requires an active connection to the Reportei API.
  • Needs an API authentication token or key configured in n8n credentials (referred generically as "an API key credential").
  • The node uses HTTP requests to interact with Reportei endpoints such as /create_report.
  • The node dynamically loads options for projects and integrations via authenticated API calls.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Selecting a project ID that does not exist or is inaccessible will result in errors when loading integrations or creating reports.
    • Providing invalid date formats or inconsistent date ranges (e.g., end date before start date) may cause API rejections.
    • Empty required fields like project ID or report title will prevent successful report creation.

  • Error messages:

    • Authentication errors usually indicate misconfigured or expired API keys; verify and update credentials.
    • "No valid operation was performed" indicates that the node parameters did not match any supported operation; ensure correct resource and operation selections.
    • HTTP request failures may return error messages from the API; check network connectivity and API status.

Links and References

Discussion