Commanders Act icon

Commanders Act

Use the Commanders Act API

Actions83

Overview

This node integrates with the Commanders Act API to manage and retrieve data related to event delivery health for a specified destination. Specifically, the "Get Destination Event Delivery Health" operation provides an overview of the delivery health status of events sent to a particular destination over a given period. It returns statistics on successful and failed events along with historical datasets for each event type during the last 30 days.

This node is beneficial in scenarios where you need to monitor and analyze the reliability and performance of event deliveries to external systems or integrations. For example, marketing teams can use it to ensure that customer event data is being correctly delivered to analytics platforms or CRM systems, enabling timely troubleshooting of delivery issues.

Properties

Name Meaning
Event Delivery ID The unique identifier of the event delivery destination whose health status you want to retrieve.
Query Parameters Optional parameters to refine the request. These include:
- end: End date/time for the query.
- Fields[template]: Template fields to include.
- Various filter options such as date ranges, search terms, segment IDs, device/location filters.
- granularity: Level of detail for the data.
- include: Additional data to include.
- Pagination (page) and sorting (sort) options.
- source, start, token (API token, password type).

Output

The output JSON contains the response from the Commanders Act API regarding the event delivery health. This typically includes:

  • Statistics on the number of succeeded and failed events.
  • Historical datasets showing event delivery trends over the last 30 days.
  • Breakdown by event types and other relevant metrics.

If the API returns binary data (not typical for this operation), it would represent raw data files or reports related to event delivery health.

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 for successful requests.

Troubleshooting

  • Missing Credentials: If the API credentials are not set or invalid, the node will throw an error indicating missing credentials.
  • Required Parameter Missing: The node requires the "Event Delivery ID" property for this operation. Omitting it will cause an error.
  • API Errors: Any errors returned by the Commanders Act API (e.g., invalid ID, permission issues) will be surfaced as node errors with descriptive messages.
  • Invalid Query Parameters: Providing malformed or unsupported query parameters may result in API errors or empty responses.
  • Network Issues: Connectivity problems to the Commanders Act API endpoint will cause request failures.

To resolve these issues:

  • Ensure API credentials are correctly configured.
  • Provide all required parameters.
  • Validate query parameters against the API documentation.
  • Check network connectivity and firewall settings.

Links and References

Discussion