Klaviyo icon

Klaviyo

Interact with the Klaviyo API

Actions17

Custom Metric → Get One

AI-generated

Overview

This node interacts with the Klaviyo API to retrieve a single Custom Metric by its ID. It is useful for scenarios where you need detailed information about a specific custom metric, such as its name, creation date, update date, and definition details. For example, marketing analysts or developers can use this node to fetch and analyze a particular custom metric's data for reporting or integration purposes.

Use Case Examples

  1. Retrieve a custom metric by its ID to display its details in a dashboard.
  2. Fetch specific fields of a custom metric to use in automated workflows or data processing.

Properties

Name Meaning
Custom Metric ID The unique identifier of the custom metric to retrieve. This is a required field for the operation.
Custom Metric Fields Specifies which fields of the custom metric to return, such as name, created, updated, definition, and specific subfields of the definition like aggregation method and metric groups.
Additional Resources Additional related resources to include in the response, such as metrics.
Metric Fields Specifies which fields of the included metric resources to return, such as name, created, updated, and integration. Requires 'metrics' to be included in Additional Resources.
Request Options Additional request options such as batching, SSL certificate validation, proxy settings, and timeout configuration.

Output

JSON

  • id - The unique identifier of the custom metric.
  • name - 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 detailed definition object of the custom metric, including aggregation method and metric groups.
  • metrics - Included related metric resources if requested, containing specified metric fields.

Dependencies

  • Klaviyo API key credential for authentication

Troubleshooting

  • Ensure the Custom Metric ID is correctly provided and exists in the Klaviyo account to avoid 'not found' errors.
  • Verify that the API key credential has sufficient permissions to access custom metrics.
  • If SSL issues occur, consider enabling the 'Ignore SSL Issues' option, but be aware of security risks.
  • Check proxy settings if requests fail due to network restrictions or firewall rules.
  • Timeout errors can be resolved by increasing the timeout value in Request Options if the server response is slow.

Links

Discussion