Commanders Act icon

Commanders Act

Use the Commanders Act API
Join our community

Actions108

Overview

This node integrates with the Commanders Act API, specifically allowing users to manage and interact with various resources related to web containers, including web perimeters. The "List Web Perimeters" operation fetches a list of web perimeters configured in the Commanders Act platform for a given site.

This node is beneficial when you want to automate retrieval and management of web perimeter configurations within your marketing or data governance workflows. For example, you might use it to synchronize perimeter definitions with other systems, audit perimeter settings regularly, or trigger actions based on perimeter data changes.

Properties

Name Meaning
Query Parameters A collection of optional query parameters to filter, sort, paginate, or customize the API response. Supported parameters include: end, Fields[template], filter (and its subfields like begin_date, end_date, search, etc.), granularity, include, page, sort, source, start, and token. These allow fine control over which web perimeters are returned and how the results are formatted.

The full list of query parameters includes:

  • End
  • Fields[template]
  • Filter (JSON object)
  • Filter[begin_date]
  • Filter[end_date]
  • Filter[from]
  • Filter[rangeType]
  • Filter[search]
  • Filter[segment_id]
  • Filter[sup_filters][device][]
  • Filter[sup_filters][location][]
  • Filter[to]
  • Filter[types]
  • Granularity
  • Include
  • Page (JSON)
  • Sort (JSON or string depending on context)
  • Source
  • Start
  • Token (password type)

These parameters correspond directly to the API's filtering and pagination capabilities.

Output

The output is an array of JSON objects representing the web perimeters retrieved from the Commanders Act API. Each item corresponds to a web perimeter entity with its associated properties as defined by the API.

If the API returns binary data (not typical for this operation), it would be handled accordingly, but for listing web perimeters, the output is purely JSON.

Dependencies

  • Requires an API key credential for authenticating with the Commanders Act API.
  • The node uses the base URL https://api.commander1.com/v2.
  • Proper configuration of the API credentials in n8n is necessary before using this node.
  • The node expects the user to provide the site ID and API token via credentials.

Troubleshooting

  • Missing Credentials: If the API credentials are not set or invalid, the node will throw an error indicating missing credentials.
  • Required Parameter Missing: If required identifiers (like perimeter ID for other operations) are missing, the node throws an error specifying which parameter is required.
  • API Errors: Any errors returned by the Commanders Act API will be wrapped and presented as node errors with messages starting with "Error calling Commanders Act API".
  • Invalid Query Parameters: Providing malformed JSON or unsupported query parameters may cause the API to reject the request.
  • Empty Response: If no web perimeters match the query, the node returns a 204 No Content status indication.

To resolve these issues:

  • Ensure API credentials are correctly configured.
  • Provide all required parameters for the selected operation.
  • Validate JSON inputs and query parameters.
  • Check API limits and permissions for the used API key.

Links and References

Discussion