Commanders Act icon

Commanders Act

Use the Commanders Act API

Actions83

Overview

This node integrates with the Commanders Act API, enabling users to interact programmatically with a wide range of Commanders Act platform features. It supports multiple resources such as activity logs, consent analysis, cookie scanner management, data cleansing transformations, destinations, event delivery, event enrichments, live reports, monitoring, segments, sources, users, web containers, and workspaces.

Common scenarios include:

  • Retrieving detailed activity logs for administrative auditing.
  • Managing cookies and custom fields in the Cookie Scanner module.
  • Creating, updating, or deleting various entities like destinations, users, or web tags.
  • Fetching live report data or consent statistics.
  • Monitoring event delivery health and issues.
  • Managing workspace and user configurations.

Practical examples:

  • Automatically list recent activity logs to monitor platform usage.
  • Create or update cookies in the Cookie Scanner to maintain compliance.
  • Retrieve live report data for analytics dashboards.
  • Manage web container tags and triggers for website tracking setups.

Properties

Name Meaning
Query Parameters A collection of optional query parameters to customize API requests. Includes parameters like end, start, filter (with subfields such as begin_date, end_date, search, etc.), granularity, include, page, sort, source, and token. These allow filtering, sorting, pagination, and scoping of data returned by the API.
Token An optional token string used for authentication or specific API calls requiring a token. Marked as password type for security.

The node also accepts many other resource-specific properties such as IDs (e.g., Alert ID, Cookie ID, Destination ID) and request bodies for POST/PATCH/PUT operations, but these are not relevant here since only the "Default" resource and operation were specified.

Output

The node outputs an array of JSON objects representing the response from the Commanders Act API. The structure of each JSON object depends on the specific API endpoint called and the resource/operation selected.

  • If the API returns a JSON string, it is parsed and output as JSON.
  • If the API returns plain text, it is output as a text field.
  • If no content is returned (HTTP 204), a status code message is output.
  • Binary data output is not indicated in this node.

Dependencies

  • Requires an API key credential for authenticating with the Commanders Act API.
  • The base URL for API requests is https://api.commander1.com/v2.
  • The node uses HTTP methods GET, POST, PATCH, PUT, DELETE depending on the operation.
  • Proper configuration of credentials in n8n is necessary for successful API calls.

Troubleshooting

  • Missing Credentials: The node throws an error if the required API credentials are not provided. Ensure that a valid API key credential is configured.
  • Required Parameter Missing: For many operations, specific IDs or parameters are mandatory (e.g., Cookie ID, Alert ID). Omitting these will cause errors indicating which parameter is missing.
  • API Errors: If the API call fails, the node throws an error with the message prefixed by "Error calling Commanders Act API". Check the error message and stack trace for details.
  • Invalid JSON in Request Body: When sending data in POST/PATCH/PUT requests, ensure the JSON body is correctly formatted; otherwise, parsing errors may occur.
  • Unknown Resource: Selecting a resource not supported by the node results in an error indicating "Unknown resource".

Links and References

This summary covers the default resource and operation context with the provided input properties.

Discussion