Commanders Act icon

Commanders Act

Use the Commanders Act API
Join our community

Actions108

Overview

This node integrates with the Commanders Act API to retrieve data related to event delivery trends for a specified destination. Specifically, the "Get Destination Event Delivery Trend" operation provides an overview of the delivery status history over a user-defined period. This is useful for monitoring how events are being delivered to destinations, identifying patterns or issues in event transmission, and optimizing event workflows.

Practical scenarios include:

  • Tracking the success and failure rates of event deliveries over time.
  • Analyzing trends to detect periods of degraded performance or outages.
  • Integrating event delivery metrics into broader analytics or alerting systems.

Properties

Name Meaning
Event Delivery ID The unique identifier of the event delivery destination for which the trend data is requested.
Query Parameters Additional optional parameters to refine the query. These include:
- end: End date/time for the trend data.
- Fields[template]: Template fields filter.
- filter (and sub-filters): JSON or string filters such as date ranges, search terms, segment IDs, device/location filters, types, etc.
- granularity: Time granularity of the trend data.
- include: Additional data to include.
- page: Pagination details.
- sort: Sorting options.
- source, start, token: Other filtering or authentication tokens.
The full list of possible query parameters allows detailed customization of the trend data request.

Output

The output is a JSON array where each item corresponds to the response from the Commanders Act API for the requested event delivery trend. The structure depends on the API's response but generally includes:

  • Historical data points representing event delivery statuses over time.
  • Metrics such as counts or percentages of successful and failed event deliveries.
  • Possibly segmented data by event type or other dimensions based on query parameters.

No binary data output is produced by 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 credentials within n8n is necessary to authorize API requests.

Troubleshooting

  • Missing Credentials: If the API key credential is not set or invalid, the node will throw an error indicating missing credentials.
  • Missing Required Parameters: For this operation, if the "Event Delivery ID" is not provided, the node throws an error stating that it is required.
  • API Errors: Any errors returned by the Commanders Act API will be wrapped and reported as node API errors with descriptive messages.
  • Invalid Query Parameters: Providing malformed JSON or unsupported query parameters may cause the API to reject the request.
  • Empty or Unexpected Responses: If the API returns empty or non-JSON responses, the node attempts to parse them; otherwise, it returns a status code message.

To resolve these issues:

  • Ensure all required input properties are correctly filled.
  • Verify API credentials are valid and have sufficient permissions.
  • Validate query parameters format and values.
  • Check network connectivity and API availability.

Links and References

Discussion