Straddle icon

Straddle

Interact with Straddle API

Actions81

Overview

This node interacts with the Straddle API to generate a report on the total number of customers by their status. It is useful for platforms or services that need to analyze customer distribution across different statuses, such as active, inactive, or pending. For example, a financial platform could use this node to monitor how many customers are currently active versus those who have closed accounts, helping in business analytics and decision-making.

Properties

Name Meaning
Straddle Account Id For use by platforms to specify an account ID and set the scope of the request (sent as header)
Request Id Optional client-generated identifier to trace and debug a specific request (sent as header)
Correlation Id Optional client-generated identifier to trace and debug a series of related requests (header)

Output

The node outputs JSON data representing the report of total customers grouped by their status. The exact structure depends on the API response but typically includes counts or aggregates per customer status category.

No binary data output is indicated for this operation.

Dependencies

  • Requires an API key credential for authenticating with the Straddle API.
  • Needs configuration of the environment subdomain (e.g., sandbox, production) to construct the base URL dynamically.
  • The node sends HTTP POST requests to the endpoint /v1/reports/total_customers_by_status.

Troubleshooting

  • Missing or invalid API credentials: Ensure the API key credential is correctly configured and has necessary permissions.
  • Incorrect environment setting: Verify the environment parameter matches the available Straddle environments to avoid connection errors.
  • Header values not set properly: If using optional headers like Request Id or Correlation Id, ensure they are correctly formatted strings.
  • API rate limits or server errors: Handle HTTP error responses gracefully; check API documentation for rate limits and retry policies.

Links and References

  • Straddle API Documentation (general reference for API endpoints and authentication)
  • n8n HTTP Request node documentation for understanding header routing and dynamic base URLs.

Discussion