Commanders Act icon

Commanders Act

Use the Commanders Act API
Join our community

Actions108

Overview

This node integrates with the Commanders Act API, specifically supporting the "Event Enrichment" resource and its operations. The Get Event Enrichment operation retrieves detailed information about a specific event enrichment by its ID or can list event enrichments with optional query parameters.

Typical use cases include:

  • Fetching enriched event data for analytics or reporting.
  • Integrating enriched event details into workflows for further processing or decision-making.
  • Filtering and querying event enrichments based on various criteria such as date ranges, filters, sorting, and pagination.

For example, you might use this node to get detailed metadata about user interaction events enriched by Commanders Act, then use that data to trigger marketing automation or generate custom reports.

Properties

Name Meaning
Event Enrichment ID The unique identifier of the event enrichment to retrieve or manipulate. Required for Get, Delete, and Patch operations on a specific event enrichment.
Query Parameters A collection of optional parameters to refine the request when listing or getting event enrichments. These include:
- End: End date/time filter.
- Fields[template]: Template fields selection.
- Filter: JSON object or string to apply complex filtering criteria.
- Filter[begin_date], Filter[end_date], Filter[from], Filter[to]: Date range filters.
- Filter[rangeType]: Type of range filter.
- Filter[search]: Search term filter.
- Filter[segment_id]: Segment identifier filter.
- Filter[sup_filters][device][], Filter[sup_filters][location][]: Filters for device and location arrays.
- Filter[types]: Types filter.
- Granularity: Level of detail in results.
- Include: Additional related data to include.
- Page: Pagination settings in JSON format.
- Sort: Sorting options in JSON or string format (depending on context).
- Source: Source filter.
- Start: Start date/time filter.
- Token: An optional token parameter, treated as a password field.

Output

The node outputs an array of JSON objects representing the response from the Commanders Act API for the requested event enrichment(s). The structure depends on the API response but typically includes detailed event enrichment data such as event metadata, enrichment attributes, timestamps, and any additional fields requested via query parameters.

If the API returns no content, the node outputs a JSON object indicating "Status Code": "204 No Content".

The node does not output binary data.

Dependencies

  • Requires an active connection to the Commanders Act API.
  • Needs valid API credentials including a site ID and an API token.
  • The base URL used is https://api.commander1.com/v2.
  • The node expects the credentials to be configured in n8n with appropriate permissions to access event enrichment endpoints.

Troubleshooting

  • Missing Credentials Error: If the node throws an error about missing API credentials, ensure that the Commanders Act API credentials are properly set up in n8n.
  • Required Parameter Missing: For operations like Get, Delete, or Patch on event enrichments, the Event Enrichment ID must be provided; otherwise, the node will throw an error indicating the missing ID.
  • Invalid Query Parameters: Providing malformed JSON or unsupported query parameters may cause API errors. Validate JSON inputs and parameter formats before execution.
  • API Errors: Any HTTP or API errors are caught and rethrown with descriptive messages. Check the error message and stack trace for details.
  • Empty Response: If the API returns no data, the node outputs a 204 status indication. Verify that the requested event enrichment exists and matches the query parameters.

Links and References

Discussion