TeleFlow icon

TeleFlow

Interact with TeleFlow API
Join our community

Actions145

Overview

This node integrates with the TeleFlow API to perform various operations on multiple resource types, including reports. Specifically, for the Report - Get operation, it retrieves a single report by its unique identifier (ID). This is useful when you need to fetch detailed information about a specific report stored in TeleFlow.

Common scenarios include:

  • Fetching a report's details for review or processing within an automation workflow.
  • Using report data as input for further decision-making or notifications.
  • Integrating TeleFlow reporting data into other systems or dashboards.

Example: You have a report ID from a previous step or external source and want to retrieve all associated data fields of that report to analyze or export.

Properties

Name Meaning
ID The unique identifier of the report to retrieve. This is required to specify which report to get.
Fields Optional key-value pairs specifying additional query parameters to filter or customize the returned data fields. Each pair consists of a field name and its corresponding value.

Output

The output is a JSON object representing the retrieved report data as returned by the TeleFlow API. It contains all the properties and values of the specified report.

  • The structure depends on the TeleFlow API response for a report but typically includes metadata and report-specific fields.
  • No binary data output is produced by this operation.

Example output snippet (conceptual):

{
  "id": "12345",
  "name": "Monthly Usage Report",
  "createdAt": "2024-01-01T00:00:00Z",
  "data": { ... }
}

Dependencies

  • Requires an API authentication credential configured in n8n to connect to the TeleFlow API.
  • The base URL for the API must be set in the credentials.
  • The node sends HTTP requests with JSON content type and expects JSON responses.

Troubleshooting

  • Missing ID error: If the ID property is not provided for the get operation, the node throws an error stating "ID is required for get operation." Ensure the ID is correctly set.
  • API connection issues: Errors related to network connectivity or invalid credentials will cause the request to fail. Verify API keys and endpoint URLs.
  • Invalid field parameters: Providing incorrect or unsupported field names/values in the Fields collection may result in unexpected API responses or errors.
  • Continue on Fail: If enabled, the node will continue processing subsequent items even if one fails, returning error details in the output JSON.

Links and References

Discussion