Canvas Analytics
AI-generatedOverview
The Braze Canvas node allows users to manage and interact with Braze Canvas campaigns through the Braze API. It supports operations such as sending multi-step campaign messages, scheduling these messages for future delivery, retrieving detailed information about specific Canvas campaigns, and fetching time-series analytics data related to Canvas campaigns.
This node is beneficial in marketing automation workflows where you want to programmatically trigger or schedule personalized campaigns, analyze campaign performance over time, or retrieve campaign metadata for reporting or decision-making purposes.
Practical examples:
- Automatically triggering a Braze Canvas campaign when a user performs a specific action on your platform.
- Scheduling a Canvas message to be sent at an optimal time based on user behavior.
- Fetching analytics data for a Canvas campaign over the last 14 days to monitor engagement trends.
- Retrieving detailed campaign information to audit or update campaign settings.
Properties
| Name | Meaning |
|---|---|
| Operation | The action to perform. Options: "Canvas Analytics", "Canvas Details", "Schedule Canvas", "Send Canvas". |
| Canvas ID | The unique identifier of the Canvas campaign to operate on. |
| Length (Days) | Number of days to include in the analytics data series (valid range: 1-100). Used only for "Canvas Analytics" operation. |
| Ending At | End date/time for the analytics data series in ISO 8601 format. Defaults to current time if not specified. Used only for "Canvas Analytics". |
Output
The node outputs JSON data corresponding to the selected operation:
- Send Canvas / Schedule Canvas: Returns the API response confirming the message was sent or scheduled, including any relevant identifiers or status messages.
- Canvas Analytics: Returns time-series analytics data for the specified Canvas campaign, covering metrics over the requested number of days ending at the specified date/time.
- Canvas Details: Returns detailed metadata about the specified Canvas campaign, optionally including draft version details.
If an error occurs during execution, the output JSON will contain an error field describing the issue, along with additional error details such as HTTP status code and Braze-specific error codes.
The node does not output binary data.
Dependencies
- Requires a valid Braze API key credential configured in n8n for authentication.
- Needs network access to the Braze API endpoints.
- Uses Braze API base URL determined by the instance configuration provided in credentials.
Troubleshooting
- Invalid JSON in Trigger Properties: When sending or scheduling Canvas messages, the node expects the "triggerProperties" input to be valid JSON. If invalid JSON is provided, an error will be thrown indicating the problem. Ensure that this field contains properly formatted JSON.
- Missing or Invalid Canvas ID: The Canvas ID is required for all operations. Omitting it or providing an incorrect ID will result in API errors.
- API Authentication Errors: If the API key credential is missing, invalid, or lacks necessary permissions, requests will fail with authentication errors.
- HTTP Errors from Braze API: Network issues, rate limiting, or invalid parameters can cause HTTP errors. The node surfaces these errors with descriptive messages and Braze error codes to help diagnose the problem.
- Date Format Issues: For the "Ending At" property in analytics, ensure the date/time is in valid ISO 8601 format; otherwise, the API may reject the request.
To resolve errors, verify input parameters, ensure correct credential setup, and consult Braze API documentation for error code meanings.