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 web internal variables within their Commanders Act web containers. It is useful for retrieving detailed information about internal variables configured in web containers managed by Commanders Act.

Typical use cases include:

  • Automating the retrieval of internal variable configurations for auditing or synchronization.
  • Integrating Commanders Act data into workflows that require access to web container variables.
  • Filtering and querying internal variables based on various parameters to support analytics or reporting.

For example, a marketing team could use this node to fetch all internal variables currently defined in a web container to ensure consistency across campaigns.

Properties

Name Meaning
Query Parameters A collection of optional query parameters to filter or paginate the list of web internal variables. Supported keys include: end, Fields[template], filter (and nested filters like begin_date, end_date, search, etc.), granularity, include, page, sort, source, start, and token. These allow fine-tuning the API request to retrieve specific subsets of variables.

The "Query Parameters" property supports multiple options such as:

  • End: End date/time for filtering.
  • Fields[template]: Template fields selection.
  • Filter: JSON object or string to apply complex filters.
  • Granularity: Level of detail or aggregation.
  • Include: Additional related data to include.
  • Page: Pagination details.
  • Sort: Sorting criteria.
  • Source: Source identifier.
  • Start: Start date/time for filtering.
  • Token: Authentication token (password type).

Output

The node outputs an array of JSON objects representing the web internal variables retrieved from the Commanders Act API. Each item corresponds to one internal variable with its associated properties as returned by the API.

If the API response is empty, the node returns a JSON object indicating "204 No Content".

No binary data output is produced by this operation.

Dependencies

  • Requires an active connection to the Commanders Act API.
  • Requires valid API credentials including a site ID and an API token.
  • The node uses HTTP requests to the Commanders Act API endpoint at https://api.commander1.com/v2.
  • 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 credentials are correctly set up in n8n.
  • Required Parameter Missing: The node expects certain parameters depending on the operation. For listing web internal variables, ensure that any required IDs or tokens are provided if applicable.
  • API Request Failures: Network issues or invalid tokens can cause API call failures. Verify network connectivity and credential validity.
  • Invalid Query Parameters: Providing malformed JSON or unsupported filter values in query parameters may result in API errors. Validate the input format carefully.
  • Unexpected Response Format: If the API returns a non-JSON response, the node attempts to parse it; failure to parse will return raw text. Check API status or response content if this occurs.

Links and References

This summary is based solely on static analysis of the provided source code and property definitions.

Discussion