Reportei icon

Reportei

Perform actions with Reportei API

Actions3

Overview

This node integrates with the Reportei API to create dashboards, reports, or timeline entries based on user input. Specifically for the Dashboard - Create operation, it allows users to generate a new dashboard within a selected project by specifying integrations, analysis periods, and descriptive titles.

Common scenarios where this node is beneficial include:

  • Automating the creation of performance dashboards for different projects.
  • Generating comparative dashboards over specific time periods.
  • Integrating multiple data sources (integrations) into a single dashboard report.

For example, a marketing team could use this node to automatically create a dashboard summarizing campaign results from various social media integrations over the last month, including comparison to the previous period.

Properties

Name Meaning
Project Name or ID Select the project in which to create the dashboard. Options are loaded dynamically from available projects. Can also specify an ID via expression.
Integration Names or IDs Choose one or more integrations to include in the dashboard. Options depend on the selected project and can be specified via expressions.
Title Define the main title of the dashboard.
Subtitle Define a subtitle for the dashboard to provide additional context.
Analysis Start The start date/time for the analysis period covered by the dashboard.
Analysis End The end date/time for the analysis period covered by the dashboard.
Comparison Period Start The start date/time for the comparison period to benchmark against the analysis period.
Comparison Period End The end date/time for the comparison period.

Output

The node outputs JSON data representing the response from the Reportei API after creating the dashboard. This typically includes details about the newly created dashboard such as its ID, title, associated project, and included integrations.

No binary data output is produced by this operation.

Example output structure (simplified):

{
  "id": "dashboard_id",
  "title": "Dashboard Title",
  "subtitle": "Dashboard Subtitle",
  "client_id": "project_id",
  "selected_sources": ["integration_id1", "integration_id2"],
  "analysis_start": "2024-01-01T00:00:00Z",
  "analysis_end": "2024-01-31T23:59:59Z",
  "comparison_start": "2023-12-01T00:00:00Z",
  "comparison_end": "2023-12-31T23:59:59Z"
}

Dependencies

  • Requires an active connection to the Reportei API using an API key credential configured in n8n.
  • The node uses authenticated HTTP requests to interact with Reportei endpoints.
  • Dynamic loading of options (projects and integrations) depends on successful API calls to Reportei.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Selecting a project without available integrations may result in empty integration lists.
    • Date fields must be valid ISO date-time strings; invalid dates may cause API errors.

  • Error messages:

    • "No valid operation was performed": Indicates that the resource-operation combination was not recognized or parameters were missing.
    • HTTP errors from the API (e.g., 401 Unauthorized, 404 Not Found) usually indicate credential or resource selection problems.

  • Resolutions:

    • Verify API credentials and permissions.
    • Ensure the project ID exists and has integrations.
    • Validate date inputs and ensure they follow expected formats.
    • Use the "Continue On Fail" option in n8n to handle errors gracefully during execution.

Links and References

Discussion