Klaviyo released a new generation of API in October of 2022. This repository is meant for external developers building on top of Klaviyo to better understand how these new APIs work.
The format of these guides is Jupyter notebooks with a mixture of written explanations, screenshots, and code snippets of real-world examples. The guides use Python, but developers should know that Klaviyo's APIs and SDKs support a broad range of languages.
These guides are meant both for new and experienced Klaviyo developers.
Currently, there are two guides in this repository: Understanding customer data and Understanding client-side requests. You can see a preview below of the material covered in each guide.
Learn how Klaviyo data is structured into events, profiles, and metrics. The guide covers a range of use cases from using Klaviyo's APIs to pull customer profiles, to more advanced examples such as identifying customers who made their first purchase during Black Friday / Cyber Monday.
FAQs covered:
- Who is this guide meant for?
- What do I need to follow along?
- What's an SDK?
- What's an API private key?
- What is the general structure of Klaviyo's API responses?
- How is customer profile data structured specifically?
- How are events and customer profiles related?
- What is a Klaviyo ID?
- How can I get customer profile IDs?
- How can I get list or segment IDs?
- What is pagination?
- What's a simple example of pagination?
- What does the links argument mean?
- How can I filter events based on date?
Learn how to set up a custom integration sending data into Klaviyo. The guide covers examples ranging from how to upload an event to Klaviyo to an example of how client-side requests can be used to generate custom customer review events that can be used to trigger flows.
FAQs covered:
- Who is this guide meant for?
- What's a client-side request?
- What do I need to follow along?
- What's an SDK?
- Where can I find Klaviyo's SDKs?
- Why is this guide in Python and not JavaScript?
- Where can I find examples of custom integrations using JavaScript?
- Why might some metrics appear twice in my account?
- How are metrics and events related?
- Do I need to provide a schema for new event types?
- What happens if I upload events with the wrong data type?
- How can event data be used in Flows/Templates?
- Why is my API response a 202?
- Why is my API response a NoneType?
- How can rate limit issues be mitigated?
- Why may Klaviyo reject a correctly formatted phone number?
For the best user experience reading these guides, please view them on NBViewer rather than natively in Github. You can find Klaviyo's API guides on NBViewer here.