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 operations on "Web Containers Variable" resources. The selected operation "Get Web Datalayer Variables" allows users to retrieve web datalayer variables managed within Commanders Act's tag management system. This is useful for scenarios where you want to programmatically fetch and analyze data layer variables used in your web containers for analytics, personalization, or tag management purposes.

Practical examples include:

  • Fetching specific datalayer variables by ID to inspect their configuration.
  • Listing all datalayer variables with optional query parameters to filter or paginate results.
  • Integrating this data retrieval into automated workflows that monitor or audit web container configurations.

Properties

Name Meaning
Datalayer Variable ID The unique identifier of the datalayer variable to get. Required for "Get" or "Delete" actions.
Query Parameters Optional collection of parameters to refine the request. Includes options like:
- End (string): End date/time filter.
- Fields[template] (string): Template fields filter.
- Filter (JSON): Complex filtering criteria.
- Filter[begin_date], Filter[end_date], Filter[from], Filter[to] (string): Date range filters.
- Filter[rangeType], Filter[search], Filter[segment_id], Filter[types] (string): Other filters.
- Filter[sup_filters][device][], Filter[sup_filters][location][] (string): Sub-filters arrays.
- Granularity (string): Data granularity level.
- Include (string): Additional included data.
- Page (JSON): Pagination details.
- Sort (JSON/string): Sorting instructions.
- Source (string): Data source filter.
- Start (string): Start date/time filter.
- Token (password string): Optional token parameter.

Output

The node outputs an array of JSON objects representing the response from the Commanders Act API for the requested datalayer variables. The structure depends on the API response but typically includes details about each datalayer variable such as its ID, name, type, and configuration.

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

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 credentials in n8n is necessary to authorize requests.

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: For "Get Web Datalayer Variables", the "Datalayer Variable ID" must be provided; otherwise, an error is thrown.
  • API Errors: Any errors returned by the Commanders Act API are wrapped and presented as node errors with descriptive messages.
  • Invalid Query Parameters: Incorrectly formatted JSON or unsupported query parameters may cause API request failures.
  • Empty Responses: A "204 No Content" status indicates no data was found or available for the request.

To resolve issues:

  • Ensure all required parameters are provided.
  • Verify API credentials are correctly configured.
  • Check the format and validity of any JSON input in query parameters.
  • Review API documentation for correct usage of filters and parameters.

Links and References

Discussion