Solved

52 Topics

S
Contributor I
ShazContributor I
asked in Developer Group

Klaviyo Custom properties

I am using shopify and Make (instead of Zapier) to write a custom property called MakeOrderCount. The property has number of orders placed by a customer so far. Apparently Klaviyo does not have this information to use in an email.It works all ok and I do get custom properties populated to each profile. The problem is when I am using them in a logic, it does not work. The code is: {% if person|lookup:'MakeOrderCount' > 199 %}You are at Level 10, which means you are one of our most loyal customers, someone who has created the most social impact of any customer group. Click on the links to find more about our Social Impact and Levels.{% elif person|lookup:'MakeOrderCount' == 46 %}You are at Level 9. You are few orders aways from reaching level 10.{% else %}You are on Level 1. You are few orders aways from reaching level 2.{% endif %} The problem is that it does not matter how many orders a customer has placed. The only line that executes is the first one - saying that you are at level

3
S
Contributor I
8 hours ago
U
Contributor IV
unique-username-007Contributor IV
asked in Developer Group

elevated 403 forbidden errors in the API

Hello,we are seeing in the last couple of hours sporadic errors coming from klaviyo get events API, mostly returning 403 status codes. it’s sometimes works, and sometimes returns 403 error... we couldn’t find anything in the status page but wanted to check if there’s anything we can do about it ?for what it’s worth we’re using the python sdk version 2.0.0any help would be appreciated

2
U
Contributor IV
16 hours ago
N
Contributor I
NavidiumAppContributor I
asked in Developer Group

Accessing Cookie or Identifying Tracked User

I’m working on a custom integration for our app, where we would want to query klaviyo to get a profile ID from the cookie or session somehow. Meaning, what I’m trying to do is be able to retrieve a profile ID from the cookie or something so i can map it back to a call for the full profile etc. Is this somehow possible? Can’t seem to find the api docs or guide on how we would be able to identify a klaviyo profile/tracked user on the merchant site while the site is loading/page loaded etc. 

1
S
Klaviyo Employee
8 days ago
D
Contributor I
developerjbContributor I
asked in Developer Group

API - How to get a list of profiles (Email addresses) that were removed from a list

Previously I was using the API endpoint https://a.klaviyo.com/api/v1/metric/MyListId/timeline and querying this with the since=timestamp and sort=asc and able to get a list of events that I could filter by "event_name": "Unsubscribed from List". With the new API, the replacement endpoint seems to be https://a.klaviyo.com/api/events but I can’t figure out how to get the same list of events.I tried something like this: https://a.klaviyo.com/api/events?sort=datetime&filter=equals(metric_id,%22MyListId%22)&filter=greater-or-equal(datetime,2024-04-12T02:33:00Z)But I am getting a lot more events and not able to identify what the “unsubscribe from list” events are in this endpoint. Is it possible with the /events endpoint? and if not, what other endpoint can I use to get a list of email addresses that had the "event_name": "Unsubscribed from List” since a specific timestamp?

1
S
Klaviyo Employee
13 days ago
S
Contributor I
shikha.agrawalContributor I
asked in Developer Group

Metric Aggregate Endpoint - Ordered Product by Campaign

Hello, Below is my payload for https://a.klaviyo.com/api/metric-aggregates/, however I do not get the data back broken down by campaign. However the same payload works for a different metric like “Clicked Email”{  "data": {    "type": "metric-aggregate",    "attributes": {      "metric_id": "HnmbpY",            "measurements": ["count","unique","sum_value"],      "interval": "day",      "page_size": 1000,      "timezone": "America/New_York",            "by": ["Campaign Name"],              "filter": [                    "greater-or-equal(datetime,2024-02-01)",                    "less-than(datetime,2024-02-29)"              ]    }    }} Below are payload results: Goal is to retrieve sum_value (dollar amounts) for below metrics at campaign level for given dates. Thanks,Shikha

17
S
Contributor I
16 days ago
B
Contributor I
BjornContributor I
asked in Developer Group

Klaviyo Back-In-Stock Translation: "Close" text after successful entry.

So, I have succeeded in setting up the back-in-stock flow for my Shopify store, but I’m missing one translation:The success message is followed by the word “Close”. I would like to translate this. In the inspector it looks like this:<a href="#" class="klaviyo-bis-close">Close</a>Obviously I can just change the text “Close” to whatever I want there, but how do I do this within Shopify?Thank you!

2
B
Contributor I
28 days ago
J
Contributor III
junshengContributor III
asked in Developer Group

How to get Profile ID as a variable?

Hello, I am creating a Klaviyo flow in which an external webhook is added. In the webhook, I need to get the value of the Profile ID (or Unique ID which looks like: ‘01H93QW1DV42YDCQN*********’) and add it to the request body. How I can get the value of the Profile ID as a variable? I read the official doc: https://help.klaviyo.com/hc/en-us/articles/4408802648731 that says `{{ person.id }}` can bring out the Unique ID ($id/external ID) . However, I got ‘None’ when I did it. Could anyone please advise what is the correct variable I can use to bring the value of the profileID out? Thanks! Junsheng 

6
S
Klaviyo Employee
1 month ago
M
Contributor I
matcwhiteContributor I
asked in Developer Group

v1/v2 vs v3 event payload data formats?

Hello,We have a completely custom integration where we post JSON data to the /track API to create events and trigger customer notification emails, etc.We’re now faced with migrating to the new APIs. The documentation around the migration from v1/v2 to the new APIs is ver clear on the new endpoints such as /api/events and new functionality etc.However what’s not so clear to me is any change between the data format of the original API payloads vs new API payloads?The Track API reference (https://developers.klaviyo.com/en/v1-2/docs/track-api-reference#back-end-tracking-events-server-side) refers to special fields such as $event_id, $value, $email, $first_name etc. However I cannot find any reference to these in the new documentation. For example the documentation for Create Event (https://developers.klaviyo.com/en/reference/create_event) gives the example payload JSON below: { "data": { "type": "event", "attributes": { "properties": { "newKey": "New Value" },

3
S
Klaviyo Employee
1 month ago
H
Contributor I
hammad786Contributor I
asked in Developer Group

Passed in conversion metric does not support querying for values data.

Passed in conversion metric does not support querying for values data..getting above error while calling /api/flow-values-reports/.

2
H
Contributor I
1 month ago
D
Contributor I
Dragonslayer1865Contributor I
asked in Developer Group

Insert a snippet into a Shopify form so that the form adds the Klaviyo cookie to customers?

Hello, In the Who Klaviyo tracks section of the Getting started with Klaviyo onsite tracking article, the third option for cookie-ing customers is installing custom tracking which cookies customers when they log in. Is this the correct developer documentation needed to implement this tracking? JavaScript API for identification and tracking Thank you.

2
D
Contributor I
1 month ago
K
Contributor I
KHHContributor I
asked in Developer Group

Custom metrics for Gift Cards & Invoices

We’re moving our Shopify transactional email to Klaviyo and have to create custom metrics for these emails:New gift card (Sent to the customer or different recipient when a gift card order is fulfilled) Gift card receipt (Sent to the customer if they add a different recipient to the gift card) Draft order invoice (Sent when you create an invoice on the draft order page) Order invoice (Sent when an order has an outstanding balance) Order edited (Sent when an order is edited) Order payment receipt (Sent after you charge a customer's saved payment method)In the developer guides here I found how to set up metrics for customer accounts and for order delivery updates, but nothing for Gift Cards and (Draft) Order invoices and payments. Can someone share a guide for these metrics?

2
S
Klaviyo Employee
1 month ago
D
Contributor I
devidsContributor I
asked in Developer Group

Conversion calculation from events

Using https://developers.klaviyo.com/en/reference/get_events how do I recreate the numbers in the conversion summary?  Or is this coming from shopify’s data?  

2
D
Contributor I
1 month ago
F
Contributor IV
fpicanzaContributor IV
asked in Developer Group

Looking for example on getting all the profiles that performed an activity on a campaign

On the site when I go to https://www.klaviyo.com/metric/VGrXMr/XXXXXXX/clicked-email or https://www.klaviyo.com/metric/XXXXXXX/feed/active-on-site   (I’ve masked the metric ids here) and I get a list of all the profiles who have had the “Clicked Email” or the “Active on Site” event. I need to do this through the API but the only examples I have found for this type of thing are for V1 or V2. Where can I find a sample for this that uses the stable/modern API versions ?   

9
F
Contributor IV
1 month ago
R
Contributor I
redwireContributor I
asked in Developer Group

How to subscribe user to segment via API

I have successfully subscribed a user to a list via the api and profile-subscription-bulk-create-job task. However my client is using segments and the API doesn’t seem to allow me to use a segment ID and subscribe them. Is this true? Is there another way to subscribe a user to a segment via the API?

3
S
Klaviyo Employee
1 month ago
F
Contributor IV
fpicanzaContributor IV
asked in Developer Group

attributed_message not working?

I am using API revision 2024-02-15.  If I do a post to https://a.klaviyo.com/api/metric-aggregates/ and I pass it the following json object in the body, it behaves as if I did not include the “by” command and does not aggregate by campaign but just gives it as if I did not specify the by.{       "data": {            "type": "metric-aggregate",            "attributes": {                 "measurements": [                      "count", "unique"                 ],                 "filter": [                      "greater-or-equal(datetime,2024-01-01),less-than(datetime,2024-12-31)"               ],                 "by": ["$attributed_message"],                 "interval": "month",                 "timezone": "US/Eastern",                 "metric_id": "WhateverMetric_IdUsed"            }       }  }Similarly, if in the filter I indicate the campaign I wish to see, it returns nothing at all.               "filter": [                      "greater-or-equal(datetime,2024-01-01),less-than(dateti

3
F
Contributor IV
1 month ago
M
Problem Solver I
MathildeProblem Solver I
asked in Developer Group

Help with code: Split text after number of Characters

Hi there :) Can someone help me out with a quick question? I’m currently using this code to split produt description text after full stop:  {{ catalog_item.description|split:'.'|lookup:'0' }} . However, I’m looking to define a certain numer of characters instead as the split + ending the sentence after a whole word. So for instanse I want this: “The products is great for baking” not this  “The products is great for baking wit” Best,Mathilde

4
M
Problem Solver I
1 month ago
B
Contributor I
braumContributor I
asked in Developer Group

Overwrite event data?

Hey hey, we missed some metric data related to the “Placed Order” event that we need to basically re-sync. We’re integrated via custom API, and we don’t see a way to do this without completely removing the event + details. However, we have flows set up that are triggered via that event that we don’t want to lose. How do we essentially overwrite existing metrics under that event without completely removing/re-uploading?Any thoughts?

8
C
Problem Solver II
1 month ago
B
Contributor III
babisContributor III
asked in Developer Group

API limits changed?

Since today, we are noticing values for the RateLimit–Limit header for rate limits that are not listed here: https://developers.klaviyo.com/en/docs/rate_limits_and_error_handling#rate-limitsSome of those header values:'10, 10;w=1, 150;w=60''75, 75;w=1, 700;w=60'Until now we were able to match and use those values instead:'150, 10;w=1, 150;w=60''700, 75;w=1, 700;w=60'Is this a change on purpose, on the current API stable version v2023-12-15? Should we expect new header values now? Or they are on top of the existing values, and how should we translate them?

3
Brian Turcotte
Community Manager
2 months ago
A
Contributor II
ambContributor II
asked in Developer Group

Is there a way to add "all time" as the bucket on metrics calls?

I have a use case where we’re trying to measure unique count of emails received (metric name: “recevied email”) on a flow, via the metric-aggregates API.  The issue is the following: The largest interval (bucket) is currently “month”, which means if a user receives an email on a flow on the last day of the month, and the following day in the next month, they are counted twice in the “unique” bucket since it is per interval.  Since the goal is to see total unique count of emails on a flow - this metric pull is unreliable.  For “orders” and purchases/sales, it’s fine since one can just reduce the bucket counts.Is it on the roadmap to do a interval size “all”? { "data": { "type": "metric-aggregate", "attributes": { "measurements": [ "count", "unique" ], "by": [ "$flow" ], "filter": [ // filter spans >1 month "greater-or-equal(datetim

2
A
Contributor II
2 months ago
H
Contributor I
hassanashasContributor I
asked in Developer Group

How to obtain Total Clicks, Total Opens, Unique Opens against the Campaigns using Klaviyo API

HI, I am trying to get the Total Opens, Unique Opens and Total Clicks against my campaigns.  I am able to get the Campaign Information using the following code,  import requestsimport pandas as pd url = "https://a.klaviyo.com/api/campaigns/?filter=equals%28messages.channel%2C%27sms%27%29"headers = { "accept": "application/json", "revision": "2023-12-15", "Authorization": f"Klaviyo-API-Key {API_KEY}"}response = requests.get(url, headers=headers)campaigns = response.json()data = campaigns['data']transformed_data = [{ 'id': item['id'], 'Name': item['attributes']['name'], 'Status': item['attributes']['status'], 'Send Date': item['attributes']['send_time'] } for item in data]campaigns_df = pd.DataFrame(transformed_data) What I need now is the Total Clicks, Unique Opens and Total Opens against these campaigns over a certain period of time. I have been trying to use query metric aggregates endpoint but its not helping me at all.  What I have tried so far is the followi

2
H
Contributor I
2 months ago
B
Contributor III
babisContributor III
asked in Developer Group

Header with the value of API limits changed format?

Hi, we are integrating with the new API, and we are managing the headers with the API limits as per https://developers.klaviyo.com/en/docs/rate_limits_and_error_handling#query-param-rate-limits. We have observed and used those limits so far (values in header): '60, 3;w=1, 60;w=60''150, 10;w=1, 150;w=60''700, 75;w=1, 700;w=60''3500, 350;w=1, 3500;w=60' Since yesterday, we are receiving a different value, specifically when importing profiles: https://developers.klaviyo.com/en/reference/get_profiles without adding the predictive analytics: “('0, 150, 10;w=1, 0, 150;w=60, 0;w=0',)”“('0, 700, 75;w=1, 0, 700;w=60, 0;w=0',)”"('0, 3500, 350;w=1, 0, 3500;w=60, 0;w=0',)" which we do not know how to interpret. What limit does it represent? Is this a new value or a replacement to an existing one? It changed not only the value but the type as well, this is now a tuple?Has something changed? This is awkward, as we regard this as a stable API and nothing major should change in a specific version afte

4
Brian Turcotte
Community Manager
2 months ago
H
Contributor I
hassanashasContributor I
asked in Developer Group

I can get Opened Email Count by Messages but how do I get the same for Campaigns

Hi,  I need to figure out a way to get the count of emails opened, I am able to get the Campaigns data with the following code, import requestsurl = "https://a.klaviyo.com/api/campaigns/?filter=equals(messages.channel,'email')"headers = { "accept": "application/json", "revision": "2023-12-15", "Authorization": f"Klaviyo-API-Key {API_KEY}"}response = requests.get(url, headers=headers)campaigns = response.json()data = campaigns['data']transformed_data = [{ 'id': item['id'], 'Name': item['attributes']['name'], 'Status': item['attributes']['status'], 'Send Date': item['attributes']['send_time'] } for item in data]campaigns_df = pd.DataFrame(transformed_data) Now, I want to get the following items against each Campaign,  Opened Email CountUnique Opens Click Rates  I understand that I need to use Query End Parameter for this purpose. My understanding is that if we want to group the data by campaign_id, then we use by = [‘$attributed_message’]. So I used the following

7
S
Klaviyo Employee
2 months ago
D
Contributor I
DanErezSDContributor I
asked in Developer Group

Easiest way to get events per profile using API (for all profiles)?

I would like to fetch a list of event types and times per user for all profiles.I saw I can fetch all profiles and all events. I then have to run a query per event to fetch the profile asociated with the event. I then habe to write some code to save the information I want to be per profile instead of per event. is there any simpler/faster way to export this data in bulk? 

2
S
Klaviyo Employee
2 months ago
B
Contributor I
BoLiangContributor I
asked in Developer Group

API endpoint to fetch campaign ID and flow stats

We are currently integrating with Klaviyo for email reporting. We need to fetch campaign performance stats and flow performance stats from the API using Query Metric Aggregate Endpoint. We encountered two problems: In the supported attributes, it seems that we can only fetch data aggregated by campaign name not by campaign id. In this case, how can we ensure the campaign is unique (sometimes different campaign ids can have same campaign name)? In the supported attributes, it seems that there is no flow stats. Is there an API endpoint to fetch flow stats?

2
S
Klaviyo Employee
2 months ago
M
Problem Solver I
MathildeProblem Solver I
asked in Developer Group

Appending email address in the URL,GDPR & Data Security

Hi there :) I hope someone can help! I need to send information about the customer email in the URL - This has initially been asked and answered in this earlier post here. However, this provides issues with GDPR and Data Security. Currently the customer information is directly accessible in the URL when using this method:email={{ email }} email=Name.LastName%40email.comTherefore I need to figure out, if I can hash the information in the URL. Fingers crossed that someone has the answer to this! Thanks,Mathilde

6
M
Problem Solver I
2 months ago

Most helpful members this week

Terms & ConditionsCookie settings

Links & Resources

Platforms

Partners

Useful Things

About

  • Terms and Privacy
    © 2024 Klaviyo All rights reserved. Klaviyo and the Klaviyo logo are trademarks or registered trademarks of Klaviyo, Inc. or its affiliates.