Commanders Act icon

Commanders Act

Use the Commanders Act API

Actions108

Overview

This node integrates with the Commanders Act API to retrieve detailed reports about event delivery issues for a specified destination. Specifically, the "Get Destination Delivery Issues" operation fetches information on problems encountered during event delivery within a given period. This is useful for monitoring and troubleshooting data integration pipelines where events are sent to various destinations, helping users identify and resolve delivery failures or delays.

Practical examples include:

  • Fetching recent delivery issues to alert a team about integration problems.
  • Analyzing patterns of delivery failures over time to improve system reliability.
  • Investigating specific issue details by their ID to understand root causes.

Properties

Name Meaning
Issue ID The unique identifier of the event delivery issue to retrieve. Required for this operation.
Query Parameters A collection of optional parameters to filter or modify the request. Possible options include:
- End (string): End date/time for filtering.
- Fields[template] (string)
- Filter (JSON string) and various filter subfields such as begin_date, end_date, from, rangeType, search, segment_id, sup_filters for device/location arrays, to, types.
- Granularity (string)
- Include (string)
- Page (JSON)
- Sort (JSON or string)
- Source (string)
- Start (string)
- Token (password string)

Output

The node outputs an array of JSON objects representing the response from the Commanders Act API for the requested event delivery issues. The structure depends on the API response but generally includes detailed information about each delivery issue, such as timestamps, error messages, related event data, and status codes.

If the API returns no content, the output will indicate a "204 No Content" status.

No binary data output is involved in 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 for all requests.
  • Proper configuration of the API credentials in n8n is necessary before use.

Troubleshooting

  • Missing Credentials: If the API key credential is not set, the node throws an error indicating missing credentials.
  • Required Parameter Missing: The node requires the Issue ID parameter for this operation; if omitted, it throws an error specifying the missing Issue ID.
  • API Errors: Any errors returned by the Commanders Act API are caught and rethrown with descriptive messages including the original error message and stack trace.
  • Invalid Query Parameters: Providing malformed JSON or unsupported query parameters may cause API errors.
  • Empty Response: A "204 No Content" status indicates no data was found for the given parameters.

To resolve these issues:

  • Ensure API credentials are correctly configured.
  • Provide all required parameters, especially the Issue ID.
  • Validate JSON inputs and query parameters.
  • Check API documentation for correct usage of filters and parameters.

Links and References

Discussion