Skip to main content
Solved

flow API doesn't return variant info


Forum|alt.badge.img+2
  • Contributor II
  • 4 replies

I am calling this API:

https://a.klaviyo.com/api/v1/flow/FLOW_ID/action/NUMERICAL_ACTION_ID/email?api_key=****

It works fine except that it doesn’t return variant info somehow. How can I get the info?

Thank you in advance!

Best answer by Taylor Tarpley

Hi all, 

 

I was able to see that a support member was able to do additional testing to confirm that the current version of endpoint (V1 version), the call shown below, does not support variation level exporting.

https://a.klaviyo.com/api/v1/flow/FLOW_ID/action/NUMERICAL_ACTION_ID/email?api_key=****


 
However, our product team has noted that we do plan to support variation level data in V3 - however, we do not have a definite timeline as to when this endpoint will be released (expected V3 release for this endpoint would be Q3 or later in this year).
 

-Taylor 

View original
Did this topic or the replies in the thread help you find an answer to your question?

9 replies

Taylor Tarpley
Community Manager
Forum|alt.badge.img+60
  • Community Manager
  • 2148 replies
  • March 10, 2022

Hi @KY H

 

Welcome to the community! 

 

By the request you shared, it looks like your wanting to explicitly access Flow Message IDs and Flow Message Names directly via API calls. This is definitely doable with some work, outlined in Dov’s awesome response in a similar topic linked below. In this response for the request, did you include the Flow Message name and actual Klaviyo ID of the Message? 

 

 

Thanks for participating in the Community!

-Taylor 


Forum|alt.badge.img+2
  • Author
  • Contributor II
  • 4 replies
  • March 10, 2022

Hi Taylor,

 

Yes, I got the flow message IDs and names but not variant info which is very important to me. Currently what I see is all aggregated numbers not separated by the variant IDs (A or B). Do I need to make another call to get the info?

 

KY


Taylor Tarpley
Community Manager
Forum|alt.badge.img+60
  • Community Manager
  • 2148 replies
  • March 10, 2022

Hi @KY H,

 

Thanks for providing that additional info, it was helpful! Do you mind going into the event data of your flow message you’re trying to receive and investigating whether or not the Variant IDs are being pushed over from Shopify at all? If not, I would recommend reaching out to Shopify's support team to see if they can pass this data through into Klaviyo or create  a custom metric through the API

 

Hope this helps!

-Taylor 


Forum|alt.badge.img+2
  • Author
  • Contributor II
  • 4 replies
  • March 10, 2022

Thanks Taylor. I will follow up but I see the variant info if I download the flows report manually. Does that mean Shopify side is working? 

 

KY


Forum|alt.badge.img+2
  • Author
  • Contributor II
  • 4 replies
  • March 11, 2022

So to summarize what I found so far:

  1. I get the variant info from manual downloads without any problem. I presume that it means the Shopify is passing the info?
  2. From a flow message of “SEND_MESSAGE” type, this is what I receive:

Fron actions:

{
   "object":"flow-action",
   "id":xxxxxyyy,
   "flow_id":"...",
   "type":"SEND_MESSAGE",
   "rank":0,
   "delay_seconds":0,
   "send_time":"None",
   "timezone":"None",
   "settings":{
      
   },
   "status":"live",
   "created":"2021-09-30 16:56:47",
   "updated":"2021-10-12 14:16:22"
}

From action:

{
   "object":"flow-message",
   "id":"...",
   "name":"...",
   "from_label":"...",
   "from_email":"hello@xxxxxx.com",
   "reply_to_email":"",
   "cc_email":"",
   "bcc_email":"",
   "subject":"",
   "recipient_conditions":"None",
   "created":"2021-09-30 16:56:47",
   "updated":"2021-10-11 14:06:29"
}

 

Can you elaborate on “create  a custom metric through the API.”? The link doesn’t seem to show how to create a custom metric but more like how to retrieve existing ones.

 

Thanks!

 

KH


Forum|alt.badge.img+2
  • Author
  • Contributor II
  • 4 replies
  • March 12, 2022

My guess is that the endpoint has a parameter to specify whether I want email variation info @Taylor Tarpley. Again I don’t have any problem in getting this info through the analytics report download. The reason I think there is a parameter to control is that the report download has an option (which is on by default):

Anyway I sent an email to the support

 

KY


Taylor Tarpley
Community Manager
Forum|alt.badge.img+60
  • Community Manager
  • 2148 replies
  • Answer
  • March 18, 2022

Hi all, 

 

I was able to see that a support member was able to do additional testing to confirm that the current version of endpoint (V1 version), the call shown below, does not support variation level exporting.

https://a.klaviyo.com/api/v1/flow/FLOW_ID/action/NUMERICAL_ACTION_ID/email?api_key=****


 
However, our product team has noted that we do plan to support variation level data in V3 - however, we do not have a definite timeline as to when this endpoint will be released (expected V3 release for this endpoint would be Q3 or later in this year).
 

-Taylor 


Forum|alt.badge.img

Any updates regarding this issue?


Brian Turcotte
Forum|alt.badge.img+37

Hi @KareemRashwan!

 

If by variant info, you mean different flow messages, then you could accomplish this by including the flow action and then the associated flow message resources, given a flow ID:

/api/flows/:flow-id?include=flow-actions.flow-messages

 

Best,

Brian