Commanders Act icon

Commanders Act

Use the Commanders Act API

Actions108

Overview

This node integrates with the Commanders Act API, specifically enabling management of "Web Container" resources. The "Create Web Perimeter" operation allows users to create a new web perimeter within the Commanders Act platform. A web perimeter typically defines boundaries or rules for web tracking containers, useful in managing tags, triggers, and data collection scopes on websites.

Practical scenarios include:

  • Defining a new perimeter to segment website areas for tag management.
  • Organizing web containers by logical perimeters for better control and compliance.
  • Automating perimeter creation as part of a larger workflow managing web analytics or marketing tags.

Example: Automatically creating a web perimeter when onboarding a new website section to ensure proper tag deployment and data governance.

Properties

Name Meaning
Query Parameters Optional URL query parameters to customize the API request. Includes filters, pagination, sorting, date ranges, etc.
Request Body JSON object containing the details of the web perimeter to create. This is the main payload sent to the API.

The "Query Parameters" collection supports various fields such as:

  • end, start: Date/time range limits.
  • filter and nested filter options (e.g., filter[begin_date], filter[search]).
  • Pagination (page), sorting (sort), granularity, source, token, and others.

These allow fine-tuning the API call but are optional depending on the operation specifics.

Output

The node outputs an array of JSON objects representing the API response from the Commanders Act service after creating the web perimeter. The exact structure depends on the API's response but generally includes details about the newly created web perimeter such as its ID, name, configuration, and status.

No binary data output is involved.

Dependencies

  • Requires an API key credential for authenticating with the Commanders Act API.
  • The base URL used is https://api.commander1.com/v2.
  • The node expects valid credentials configured in n8n to authorize requests.
  • The API expects JSON content type for requests and responses.

Troubleshooting

  • Missing Credentials: If the API key credential is not set or invalid, the node will throw an error indicating missing credentials.
  • Required Parameter Missing: If mandatory parameters like the perimeter ID (for other operations) or request body are missing, the node throws descriptive errors.
  • API Errors: Any HTTP or API-level errors are caught and rethrown with detailed messages including stack traces if available.
  • Invalid JSON in Request Body: The request body must be valid JSON; otherwise, parsing errors will occur.
  • Unexpected Response Format: If the API returns a non-JSON string, the node attempts to parse it; failure results in returning raw text or a 204 No Content status.

To resolve issues:

  • Ensure all required input properties are provided.
  • Validate JSON syntax in the request body.
  • Confirm API credentials are correctly configured and have necessary permissions.
  • Check network connectivity and API endpoint availability.

Links and References


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

Discussion