Actions17
Custom Metric → Get Many
AI-generatedOverview
This node interacts with the Klaviyo API to retrieve multiple Custom Metrics. It allows users to specify which fields of the Custom Metrics they want to retrieve, include additional related resources such as metrics, and select specific fields of those related metrics. This is useful for scenarios where users need to fetch detailed information about multiple custom metrics for analysis, reporting, or integration purposes.
Use Case Examples
- Fetching a list of custom metrics with their names and creation dates for reporting.
- Retrieving custom metrics along with related metric details to analyze performance data.
Properties
| Name | Meaning |
|---|---|
| Custom Metric Fields | Specifies which fields of the Custom Metric resource to retrieve, such as name, created date, updated date, and definition details. |
| Additional Resources | Specifies additional related resources to include in the response, such as metrics. |
| Metric Fields | Specifies which fields of the related metric resources to retrieve, such as name, created date, updated date, and integration details. Requires 'metrics' to be included in Additional Resources. |
| Request Options | Additional request options including batching (to throttle requests), ignoring SSL issues, proxy settings, and request timeout. |
Output
JSON
id- The unique identifier of the custom metric.type- The type of the resource, typically 'custom-metric'.attributesname- The name of the custom metric.created- The creation timestamp of the custom metric.updated- The last updated timestamp of the custom metric.definition- The definition object containing details like aggregation method and metric groups.
includedmetrics- Included related metric resources if requested.
Dependencies
- Klaviyo API
- An API key credential for authentication
Troubleshooting
- Ensure the API key credential is correctly configured and has the necessary permissions to access custom metrics.
- If the request times out, consider increasing the timeout setting in Request Options.
- If SSL certificate validation fails and you trust the source, enable 'Ignore SSL Issues' to bypass validation.
- When using batching, ensure batch size and interval are set appropriately to avoid rate limiting or excessive delays.
Links
- Klaviyo Custom Metrics API Documentation - Official documentation for the Klaviyo Custom Metrics API endpoints and usage.