Commanders Act icon

Commanders Act

Use the Commanders Act API

Actions108

Overview

This node integrates with the Commanders Act API, specifically allowing users to manage and retrieve data related to "Web Containers" among many other resources. The "Get Web Tag" operation fetches detailed information about a specific web tag within a web container by its Tag ID. This is useful for scenarios where you need to programmatically access or audit web tags configured in your Commanders Act environment.

Practical examples include:

  • Retrieving configuration details of a particular web tag to verify its settings.
  • Automating audits or synchronization tasks involving web tags.
  • Integrating web tag data into broader workflows for analytics or compliance reporting.

Properties

Name Meaning
Tag ID The unique identifier of the web tag to retrieve.
Query Parameters Optional additional parameters to refine or filter the request. Includes options like:
- End (string)
- Fields[template] (string)
- Filter (JSON)
- Filter[begin_date], Filter[end_date], Filter[from], Filter[to] (strings for date filtering)
- Filter[rangeType], Filter[search], Filter[segment_id], Filter[types] (strings for filtering)
- Filter[sup_filters][device][], Filter[sup_filters][location][] (arrays of strings)
- Granularity (string)
- Include (string)
- Page (JSON)
- Sort (JSON or string)
- Source (string)
- Start (string)
- Token (string, password type)

The "Query Parameters" collection allows fine-tuning the API call with various filters, pagination, sorting, and other options supported by the Commanders Act API.

Output

The output is a JSON array where each element corresponds to the response from the Commanders Act API for the requested web tag. The structure depends on the API's response but typically includes all properties and metadata of the specified web tag.

If the API returns binary data (not typical for this operation), it would be handled accordingly, but this operation primarily deals with JSON data representing web tag details.

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 using this node.

Troubleshooting

  • Missing Tag ID: If the Tag ID is not provided when required, the node throws an error indicating that the Tag ID is required.
  • Authentication Errors: If API credentials are missing or invalid, the node will throw an error about missing credentials or failed authentication.
  • API Request Failures: Network issues, incorrect query parameters, or API endpoint changes can cause errors. The node surfaces these as API errors with messages and stack traces.
  • Invalid JSON in Query Parameters or Request Body: If JSON fields are malformed, parsing errors may occur. Ensure JSON inputs are valid.

To resolve common errors:

  • Verify that the Tag ID is correctly set.
  • Check that the API key credential is configured and valid.
  • Review query parameters for correctness and proper formatting.
  • Inspect error messages for hints on what went wrong.

Links and References


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

Discussion