Commanders Act icon

Commanders Act

Use the Commanders Act API

Actions108

Overview

This node integrates with the Commanders Act API, enabling users to interact with various resources and operations provided by the platform. Specifically, for the Cookie Scanner resource with the List Custom Fields operation, it allows retrieving a list of all custom fields configured in the Cookie Scanner module of Commanders Act.

This functionality is useful for scenarios where you want to programmatically access metadata about custom fields used in cookie management, such as for auditing, reporting, or synchronizing these fields with other systems.

Example use cases:

  • Automatically fetching all custom fields to display or process them in downstream workflows.
  • Integrating cookie scanner custom field data into compliance reports.
  • Synchronizing custom field definitions with another data governance tool.

Properties

Name Meaning
Query Parameters A collection of optional query parameters to filter or paginate the list request. Includes options like: end, filter, page, sort, start, token (API token), and others. These allow fine-tuning the API request to retrieve specific subsets or sorted lists of custom fields.

The full list of possible query parameters includes but is not limited to:

  • end
  • Fields[template]
  • filter (JSON)
  • filter[begin_date]
  • filter[end_date]
  • filter[from]
  • filter[rangeType]
  • filter[search]
  • filter[segment_id]
  • filter[sup_filters][device][]
  • filter[sup_filters][location][]
  • filter[to]
  • filter[types]
  • granularity
  • include
  • page (JSON)
  • sort (JSON or string)
  • source
  • start
  • token (password type)

These parameters are passed as URL query parameters to the API endpoint.

Output

The node outputs an array of JSON objects representing the custom fields retrieved from the Commanders Act Cookie Scanner API.

  • The output JSON structure corresponds directly to the API response for listing custom fields.
  • Each item in the output array represents one custom field with its properties as returned by the API.
  • If the API returns no content, the node outputs a status message indicating "204 No Content".
  • The node does not output binary data.

Dependencies

  • Requires an active connection to the Commanders Act API.
  • Requires valid API credentials including a site ID and an API token.
  • The node uses the base URL https://api.commander1.com/v2.
  • The user must configure the API credentials securely in n8n before using this node.

Troubleshooting

  • Missing Credentials Error: If the API credentials are not set or invalid, the node will throw an error "Missing Commanders Act API Credentials". Ensure that the API key/token and site ID are correctly configured.
  • Required Parameter Missing: For some operations, required parameters like IDs must be provided. For listing custom fields, no ID is required, but if you switch operations, missing required parameters will cause errors.
  • API Request Errors: Network issues, invalid tokens, or permission problems may cause API call failures. The node throws detailed errors with messages from the API to help diagnose issues.
  • Empty Response: If no custom fields exist or filters exclude all results, the node may return "204 No Content" status. Verify your query parameters or check the source system for existing data.

Links and References


This summary focuses on the Cookie Scanner resource and the List Custom Fields operation as requested, based on static analysis of the provided source code and property definitions.

Discussion