Commanders Act icon

Commanders Act

Use the Commanders Act API
Join our community

Actions108

Overview

This node integrates with the Commanders Act API, specifically enabling users to list redirect rules within the "Mix Collect Redirect Rule" resource. It allows retrieval of redirect rules configured in the Commanders Act platform, which can be useful for managing URL redirections in marketing or data collection contexts.

Typical use cases include:

  • Fetching all redirect rules to audit or analyze URL redirection behavior.
  • Integrating redirect rule data into workflows for reporting or automated updates.
  • Filtering and sorting redirect rules based on various query parameters.

For example, a marketing team might use this node to retrieve all active redirect rules to ensure they align with current campaign URLs.

Properties

Name Meaning
Query Parameters A collection of optional parameters to filter, sort, paginate, or specify fields when listing redirect rules. Options include: end, Fields[template], filter (and various filter subfields like begin_date, end_date, search, etc.), granularity, include, page, sort, source, start, and token. These allow fine-tuning of the API request to retrieve specific subsets or views of redirect rules.

The full list of query parameter options includes:

  • End: End date/time filter.
  • Fields[template]: Specify template fields to return.
  • Filter: JSON object or string to filter results; supports subfilters such as begin_date, end_date, from, rangeType, search, segment_id, device/location filters, to, and types.
  • Granularity: Level of detail or aggregation.
  • Include: Additional related data to include.
  • Page: Pagination details in JSON format.
  • Sort: Sorting criteria, either JSON or string depending on context.
  • Source: Source identifier filter.
  • Start: Start date/time filter.
  • Token: An optional token, possibly for authentication or pagination.

Output

The node outputs an array of JSON objects representing the redirect rules retrieved from the Commanders Act API. Each item corresponds to a redirect rule with its associated properties as returned by the API.

If the API returns no content, the output will indicate a "204 No Content" status.

No binary data is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating with the Commanders Act API.
  • The node uses the base URL https://api.commander1.com/v2 for API requests.
  • Proper configuration of the API credentials in n8n is necessary before using this node.

Troubleshooting

  • Missing Credentials Error: If the node throws an error about missing API credentials, ensure that the Commanders Act API key is correctly set up in n8n credentials.
  • Required Parameter Missing: For operations requiring IDs (e.g., Redirect Rule ID), if not provided, the node will throw an error indicating the missing parameter.
  • API Request Errors: Network issues or invalid query parameters may cause API errors. Review the error message for details and verify the parameters.
  • Parsing Errors: If the API response is not valid JSON, the node attempts to handle it gracefully but may output raw text or an error.

Links and References

Discussion