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 destinations within their Commanders Act environment. It allows querying and filtering of destination data using various parameters, making it useful for managing and retrieving integration destinations configured in Commanders Act.

Common scenarios include:

  • Retrieving a list of all available destinations to monitor or audit integrations.
  • Filtering destinations based on specific criteria such as date ranges, types, or segments.
  • Paginating through large sets of destinations for batch processing or reporting.

Practical example:

  • A marketing automation workflow that fetches all active destinations to synchronize them with another system or to generate reports on integration usage.

Properties

Name Meaning
Query Parameters Collection of optional query parameters to filter and control the listing of destinations. These include:
- End (string)
- Fields[template] (string)
- Filter (JSON)
- Filter[begin_date] (string)
- Filter[end_date] (string)
- Filter[from] (string)
- Filter[rangeType] (string)
- Filter[search] (string)
- Filter[segment_id] (string)
- Filter[sup_filters][device][] (string)
- Filter[sup_filters][location][] (string)
- Filter[to] (string)
- Filter[types] (string)
- Granularity (string)
- Include (string)
- Page (JSON)
- Sort (JSON or string depending on context)
- Source (string)
- Start (string)
- Token (password string)

Output

The output is an array of JSON objects representing the retrieved destinations from the Commanders Act API. Each object corresponds to a destination entity with its associated properties as returned by the API.

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

The node does not output binary data.

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 before use.

Troubleshooting

  • Missing Credentials: If the API credentials are not set or invalid, the node will throw an error indicating missing credentials.
  • Required Parameter Missing: For this operation, if required parameters like Destination ID were needed (not for listing), the node would throw an error specifying which parameter is missing. For listing, parameters are optional.
  • API Errors: Any errors returned by the Commanders Act API will be caught and rethrown as node errors with descriptive messages.
  • Empty Response: If the API returns an empty response, the node outputs a status code message instead of JSON data.
  • Invalid JSON in Query Parameters: Since some query parameters accept JSON strings, malformed JSON may cause request failures.

Links and References

Discussion