Flow, Campaign Metrics from API

Hello@ppcorp,

Wonderful question!

You can actually utilize Klaviyo’s /export endpoint as part of the Metric’s API while leveraging the ID of your conversion metric within your account to return both your campaign and flow revenue via API. 

In the request, you'd also want to specify in the "measurement" parameter that you're specifically looking for the "value", which returns the amount of revenue, and also specify in the "where" filter the campaign ID that the metric is attributed to with "$attributed_message". When calling for a flow’s conversion data, you’ll want to use the flow ID that the metric is attributed to with “$attributed_flow” instead. 

You can find more of these example requests from the  How to Export Conversion Data Help Center article in addition to our API Documentation for this particular Export Endpoint. For convenience, you can see the example requests below:

Campaigns:

curl https://a.klaviyo.com/api/v1/metric/PLACEDORDERMETRIC/export -G \
    -d api_key=API_KEY \
    -d unit='week' \
    -d measurement='value' \
    -d where='[["$attributed_message","=",'MESSAGE_ID']]'

Flows:

curl https://a.klaviyo.com/api/v1/metric/METRIC_ID/export -G \
 -d api_key=API_KEY \
 -d measurement='value' \
 -d where='[["$attributed_flow","=",'FLOW_ID']]'

I hope this helps!

David

Hey @Jolguer,

Technically speaking that value response of [0.0] you are seeing is actually correct. This is because when trying to make a call for the Clicked Email metric, that metric doesn’t record a value as a measurement. Instead, you’ll want to define the measurement as unique or count. Similarly, instead of defining the where parameter as $attributed_flow, you’ll want to use either $flow or $message depending on what your goal was.

Overall, it doesn’t seem like you’ve structured the call correctly to align with the specific metric you were trying to query for but rather kept a number of the parameters the same as the ones used to retrieve conversion (Placed order/revenue) data. I would suggest taking a further look at our Query Event Data and Native Klaviyo Metrics & Attributes references in the Developer’s Portal for a better understanding on how to structure these calls based on individual metrics. 

You can also find an example call structure to retrieve the the number of clicks in the Unique Clicks (unique_clicks) section of the How to Export Conversion Data Help Center article previously provided which I’ve also included below:

curl https://a.klaviyo.com/api/v1/metric/CLICKED_EMAIL_METRIC_ID/export -G \
    -d api_key=API_KEY \
    -d unit='week' \
    -d measurement='unique' \
    -d where='[["$message","=",'MESSAGE_ID']]'

I hope this helps!

David

GET… not a POST… got it…. now it works!

Hey @daniellanger,

This currently is a limitation pertaining to the undocumented flows V1 endpoint. Since our Product Team is looking for feedback as they actively work to introduce V3 of our API endpoint, I’ll share your use case and details with them! I know that from speaking to that team that improving upon these originally undocumented Flows V1 endpoint was a big focus for them.

If you haven’t already, you can also sign up to be an early beta tester of the V3 API endpoints and uncover some of these new improvements by joining our V3 API Beta List here. 

David