Reportei icon

Reportei

Perform actions with Reportei API

Actions3

Overview

This node integrates with the Reportei API to create timeline events (milestones) within a specified project. It allows users to add custom milestones to a project's timeline, optionally linking them to existing reports or dashboards.

Common scenarios include:

  • Tracking important project milestones or events in a visual timeline.
  • Annotating timelines with detailed descriptions and references to specific reports.
  • Enhancing project reporting by adding contextual timeline entries for stakeholders.

For example, a user might create a timeline event titled "Q2 Marketing Campaign Launch" with details about the campaign and link it to a relevant marketing performance report.

Properties

Name Meaning
Project Name or ID Select the project where the timeline event will be created. Options are loaded dynamically from available projects.
Title The title of the timeline milestone to be created.
Details Additional descriptive details about the timeline milestone.
Report Name or ID Optionally link a report or dashboard to the timeline milestone. Options depend on the selected project and are loaded dynamically.

Output

The node outputs a JSON object representing the response from the Reportei API after creating the timeline event. This typically includes confirmation details such as the created milestone's ID, title, content, linked report ID, and other metadata returned by the API.

No binary data output is produced by this node.

Example output structure (simplified):

{
  "id": "string",
  "client_id": "string",
  "title": "string",
  "content": "string",
  "report_id": "string",
  "created_at": "string"
}

Dependencies

  • Requires an active connection to the Reportei API using an API key credential configured in n8n.
  • The node dynamically loads options for projects and reports via authenticated HTTP requests to Reportei endpoints.
  • Network access to https://app.reportei.com/api/v1/ is necessary.

Troubleshooting

  • Invalid Project or Report ID: If the provided project or report ID does not exist or is incorrect, the API may return errors. Verify IDs by selecting from the dropdown or using correct expressions.
  • Authentication Errors: Ensure the API key credential is valid and has sufficient permissions.
  • Network Issues: Connectivity problems to the Reportei API endpoint can cause request failures.
  • Missing Required Fields: The node requires at least the project ID and milestone title; missing these will result in errors.
  • API Rate Limits: Excessive requests may be throttled by the API; consider adding delays or retries.

Error messages from the API are passed through in the node output when "Continue On Fail" is enabled, helping diagnose issues.

Links and References

Discussion