Commanders Act icon

Commanders Act

Use the Commanders Act API
Join our community

Actions108

Overview

This node integrates with the Commanders Act API, specifically supporting operations related to the "Cookie Scanner" resource. The "Get Custom Field" operation retrieves detailed information about a specific custom field configured in the Cookie Scanner module of Commanders Act.

Use cases include:

  • Fetching metadata or configuration details of a particular custom field used for cookie scanning and management.
  • Automating workflows that require validation or inspection of cookie scanner custom fields.
  • Integrating cookie compliance data into broader marketing or privacy automation pipelines.

For example, you might use this node to programmatically retrieve a custom field's settings before updating your website's cookie consent banner or reporting on cookie categories.

Properties

Name Meaning
Custom Field ID The unique identifier of the custom field to retrieve. This is required for the operation.
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)
- Filter[rangeType], Filter[search], Filter[segment_id], Filter[types] (strings)
- Filter[sup_filters][device][], Filter[sup_filters][location][] (strings)
- Granularity (string)
- Include (string)
- Page (JSON)
- Sort (JSON or string)
- Source (string)
- Start (string)
- Token (password string)

The "Custom Field ID" is mandatory for this operation, while "Query Parameters" allow fine-tuning the API call.

Output

The output is a JSON object representing the retrieved custom field's data from the Commanders Act API. This typically includes all properties and metadata associated with the specified custom field.

If the API returns no content, the node outputs a status code message indicating "204 No Content".

No binary data output is involved in 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 within n8n is necessary.
  • The user must provide the "Custom Field ID" to identify which custom field to fetch.

Troubleshooting

  • Missing Custom Field ID: The node will throw an error if the "Custom Field ID" is not provided. Ensure this property is set.
  • Authentication Errors: If API credentials are missing or invalid, the node throws an error indicating missing credentials or authorization failure.
  • API Request Failures: Network issues or incorrect query parameters may cause errors. Review the error message for details.
  • Unexpected Response Format: If the API returns a non-JSON response, the node attempts to parse it; if parsing fails, it returns raw text.

To resolve errors:

  • Verify the API credentials are correctly configured.
  • Confirm the "Custom Field ID" is valid and exists in your Commanders Act account.
  • Check network connectivity and API endpoint availability.
  • Review any query parameters for correctness and compatibility with the API.

Links and References

Discussion