Commanders Act icon

Commanders Act

Use the Commanders Act API

Actions108

Overview

This node integrates with the Commanders Act API, specifically enabling interaction with the "Cookie Scanner" resource to retrieve a generated version of the cookie scanner configuration. The "Get Generated Version" operation fetches details about a specific generated version of the Cookie Scanner, which is useful for managing and auditing cookie compliance versions deployed on websites.

Typical use cases include:

  • Retrieving metadata or configuration details of a particular cookie scanner version.
  • Auditing or verifying the state of cookie consent configurations before deployment.
  • Integrating cookie scanner version data into workflows for compliance reporting or automated updates.

Properties

Name Meaning
Cookie Scanner Version ID The unique identifier of the cookie scanner generated version to retrieve. This is required.
Query Parameters Optional additional parameters to refine or filter the request. Includes options such as:
- End (string)
- Fields[template] (string)
- Filter (JSON) and various filter subfields like begin_date, end_date, search, segment_id, etc.
- Granularity (string)
- Include (string)
- Page (JSON)
- Sort (JSON or string)
- Source (string)
- Start (string)
- Token (password string)

These query parameters allow fine-tuning of the API call, such as filtering by date ranges, sorting results, or specifying included fields.

Output

The node outputs an array of JSON objects representing the response from the Commanders Act API for the requested generated version of the Cookie Scanner. The structure depends on the API's response but typically includes details about the version's configuration, status, and metadata.

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

Dependencies

  • Requires an active connection to the Commanders Act API.
  • Needs valid API credentials including a site identifier and an API token.
  • The node expects these credentials to be configured in n8n prior to execution.

Troubleshooting

  • Missing Credentials: If the API credentials are not set or invalid, the node will throw an error indicating missing credentials.
  • Required Parameter Missing: If the "Cookie Scanner Version ID" is not provided, the node throws an error stating that this ID is required.
  • API Errors: Any errors returned by the Commanders Act API will be wrapped and presented as node errors with messages prefixed by "Error calling Commanders Act API".
  • Invalid Query Parameters: Providing malformed JSON or unsupported query parameters may cause the API to reject the request.
  • Network Issues: Connectivity problems to the Commanders Act API endpoint will result in request failures.

To resolve issues:

  • Ensure all required parameters are provided.
  • Verify API credentials are correctly configured.
  • Validate any JSON input for query parameters.
  • Check network connectivity and API availability.

Links and References


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

Discussion