Metric Aggregate Endpoint - Ordered Product by Campaign

Try using "$attributed_message” as the “by” value, since events like Ordered Product are attributed to a campaign (or flow) message based on the attribution window you have set in your account.

https://developers.klaviyo.com/en/docs/supported_metrics_and_attributes

Events tied directly to specific emails — Opened Email, Clicked Email, etc. — will use Campaign Name. Events that are not tied to specific messages but which can be attributed to a message — e.g. I placed an order three days after opening a campaign email — will use the “attributed” properties.

Hi, the difference is probably from how the API and the UI are treating dates.

For the API call, you are looking at all Ordered Product events on 1/1/24, and then getting the sum of those events attributed to the flow in question.

When you look at the flows report, you are looking at all flow emails sent on 1/1/24, and then getting the sum of orders attributed to the flow.

So if the flow sent me an email on 1/1/24 and I placed an order on 1/3/24, it would not be counted in the API call, but would be in the UI report.

There’s a new reporting API that will get you results that match those in the UI: https://developers.klaviyo.com/en/reference/query_flow_values

Correct, one is tracking when conversion events — e.g. Ordered Product — happened in a specified time frame, the other is tracking when messages were sent in a time frame, that led to conversion events.

Follow up question: On the reporting API, is it possible to break the data down by date when a range is given?

I think the flow series report will do this. Here’s a doc that was given to early testers of the reporting API: https://docs.google.com/document/d/1Ca8asJWWNiDJJODMsIrn1l40NthKDww64GwgqUGRg1s/edit

Heads up, you’re showing a private API key in a screenshot, I’d suggest you delete the screenshot and remove the private key from your account.

couple more questions:

How can I get the data from API, presented in this screen shot. Placed Order by Campaign:

I can get Placed Order by Attributed Message, but where in UI do I see the messages tied to the campaign?

Also what does below mean? “NgAhEY” is not an attributed message id?

Hi @shikha.agrawal!

My apologies for the delay here. To match the dashboards in the Klaviyo app with the API, I would recommend using our new Reporting API instead of the Query Metric Aggregates endpoint. 

This is because the new Reporting API endpoints pull from the same resource as the UI, so you won’t experience the discrepancy you see with the QMA endpoint. 

With the Reporting API, you can use the Query Campaign Values endpoint to retrieve conversion metrics:

• https://developers.klaviyo.com/en/reference/query_campaign_values

Hope this helps!

Best,

Brian

Hi There,

Got another question. I can get below data from API using $message attribute in metric aggregate endpoint. However I am unable to find what endpoint to use to map message id (VQkNQY) to it’s message name (WelcomeMessage). Would you please let me know how I can get this mapping?

Thanks,

Shikha