Commanders Act icon

Commanders Act

Use the Commanders Act API

Actions83

Overview

This node integrates with the Commanders Act API, specifically allowing users to manage and retrieve data related to "Web Containers" and their associated entities such as web constraints, containers, perimeters, tags, triggers, and variables. The "Get Web Constraint" operation fetches details about a specific web constraint by its ID.

Typical use cases include:

  • Retrieving configuration or metadata about a particular web constraint within a web container setup.
  • Automating management and monitoring of web container constraints in digital marketing or tag management workflows.
  • Integrating web container data into broader automation pipelines for analytics or compliance purposes.

For example, a user might want to get detailed information about a web constraint to verify its settings or to audit configurations programmatically.

Properties

Name Meaning
Constraint ID The unique identifier of the web constraint to retrieve. This is required for operations that target a specific constraint (e.g., get, update, delete).
Query Parameters Optional collection of query parameters to refine or filter the API request. Includes options like: end, Fields[template], various filter fields (e.g., date ranges, search terms), granularity, include, page, sort, source, start, and token. These allow fine-tuning of the data retrieval.

The full list of query parameters includes:

  • End
  • Fields[template]
  • Filter (and sub-filters like begin_date, end_date, from, rangeType, search, segment_id, sup_filters for device and location, to, types)
  • Granularity
  • Include
  • Page
  • Sort (including specialized sorts for event enrichments and live report builder)
  • Source
  • Start
  • Token (a password-type field)

Output

The output is a JSON array where each element corresponds to the response from the Commanders Act API for the requested web constraint(s). The structure depends on the API's response but generally contains detailed information about the web constraint entity, such as its properties, configuration, and status.

If the API returns no content, the node outputs an object indicating "Status Code": "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.
  • Proper configuration of the API credentials in n8n is necessary before using this node.
  • The node expects valid IDs and parameters depending on the operation.

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 the "Get Web Constraint" operation, if the Constraint ID is not provided, the node throws an error stating that the Constraint ID is required.
  • API Errors: Any errors returned by the Commanders Act API are wrapped and presented with the message prefix "Error calling Commanders Act API". Check the error message and stack trace for details.
  • Invalid JSON in Request Body: For operations requiring a request body, ensure the JSON is well-formed; otherwise, parsing errors may occur.
  • Empty or Unexpected Response: If the API returns an empty string or unexpected format, the node attempts to parse it; failure results in returning raw text or a 204 status indication.

Links and References

This summary focuses on the "Web Container" resource and the "Get Web Constraint" operation as requested.

Discussion