Pulse Workflow icon

Pulse Workflow

Workflow actions from Pulse API

Actions26

Overview

This node interacts with the Pulse API to manage and retrieve project-related data. Specifically, the "List Project Data" operation fetches a list of data entries associated with projects. This is useful for scenarios where you need to programmatically access detailed project data records, such as reporting, analytics, or integration with other systems.

Practical examples include:

  • Retrieving all data points collected for a specific project to analyze progress.
  • Filtering project data by certain criteria (e.g., date ranges or specific fields).
  • Paginating through large sets of project data to process them in batches.

Properties

Name Meaning
Include Related Resources Select related resources to include in the response. Currently supports including the "Project" resource to enrich the returned data with project details.
Additional Fields A collection of optional parameters to customize the query:
- Sort: Specify the sort order of results, e.g., "created_at" for ascending or "-created_at" for descending.
- Page Number: The page number for pagination (default 1).
- Page Size: Number of results per page (default 20).
- Filters: Apply filters by specifying key-value pairs to narrow down results.
- Fields: Specify which fields to include in the response for particular resource types by providing comma-separated field names.

Output

The output is a JSON array where each item represents a project data record retrieved from the Pulse API. Each record contains fields corresponding to the project data attributes, potentially enriched with related project information if requested.

If binary data were involved (not indicated here), it would typically represent files or attachments related to project data, but this operation focuses on JSON data only.

Dependencies

  • Requires an API key credential for authenticating with the Pulse API.
  • The node depends on the Pulse API service being accessible and properly configured.
  • Pagination and filtering depend on the API's support for these features.

Troubleshooting

  • Common Issues:

    • Incorrect or missing API credentials will cause authentication failures.
    • Using unsupported filter keys or invalid field names may result in empty responses or errors.
    • Requesting pages beyond the available range will return empty results.

  • Error Messages:

    • "The operation "getProjectDataList" is not supported for resource "projectData"!" — indicates a misconfiguration of the operation or resource selection.
    • Network or API errors will propagate messages from the Pulse API; ensure network connectivity and valid API endpoint configuration.

  • Resolutions:

    • Verify that the API key credential is correctly set up in n8n.
    • Double-check property values for filters, fields, and pagination parameters.
    • Use the "Include Related Resources" option carefully to avoid requesting unsupported relations.

Links and References

Discussion