Commanders Act icon

Commanders Act

Use the Commanders Act API

Actions83

Overview

This node integrates with the Commanders Act API, specifically allowing management of "Mix Collect Redirect Rules" among many other resources. The "Get Redirect Rule" operation retrieves detailed information about a specific redirect rule identified by its ID. This is useful for scenarios where you need to fetch and inspect the configuration or status of a particular redirect rule within your Commanders Act environment.

Practical examples include:

  • Fetching a redirect rule to verify its settings before applying changes.
  • Retrieving redirect rule details to audit or log configurations.
  • Using the retrieved data in workflows that conditionally process or route traffic based on redirect rules.

Properties

Name Meaning
Redirect Rule ID The unique identifier of the redirect rule to retrieve. This is required to specify which redirect rule's details should be fetched.
Query Parameters Optional additional parameters to refine or filter the request. These include various filters, pagination, sorting, date ranges, and other query options such as: End, Fields[template], Filter (with subfields), Granularity, Include, Page, Sort, Source, Start, Token (API token).

The "Query Parameters" collection supports multiple optional fields to customize the API request, including filtering by dates, search terms, segments, device/location filters, sorting options, and pagination controls.

Output

The output is a JSON array where each item corresponds to the response from the Commanders Act API for the requested redirect rule. The structure depends on the API's response but typically includes all properties and metadata of the redirect rule.

If the API returns a string response, the node attempts to parse it as JSON; if parsing fails, it outputs the raw text. If no content is returned (HTTP 204), the node outputs an object indicating "204 No Content".

No binary data output 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 all requests.
  • Proper configuration of the API credentials in n8n is necessary for successful execution.

Troubleshooting

  • Missing Redirect Rule ID: The node throws an error if the Redirect Rule ID is not provided when required. Ensure this property is set.
  • Authentication Errors: If API credentials are missing or invalid, the node will throw an error indicating missing credentials or authorization failure.
  • Invalid Query Parameters: Providing malformed JSON or unsupported query parameters may cause API errors.
  • API Errors: Any HTTP errors returned by the Commanders Act API are wrapped and reported with the message "Error calling Commanders Act API" along with the original error message and stack trace.
  • Parsing Errors: If the API returns non-JSON text unexpectedly, the node tries to handle it gracefully but may output raw text instead of structured JSON.

To resolve issues:

  • Verify all required input properties are correctly set.
  • Check API credentials and permissions.
  • Validate any JSON inputs for correctness.
  • Review API documentation for supported query parameters and expected responses.

Links and References

Discussion