How to get the value of "Revenue from Klaviyo" thru the API?

Hi@Nymesia! 

An API request like the one pasted below allows you to query for a particular metric over a defined time-range, grouping by $attributed_message and $attributed_flow, and then summing up the $value property. The group by part $attributed_message and $attributed_flow is optional, but it shows how you could break out flows from campaigns ($attributed_message) vs. flows ($attributed_flow).

It’s also worth noting that you are required to return results grouped by some time period. In this example, we return results grouped by month. If you’d like to get a single value across all months, I would recommend gathering whatever code is responsible for issuing this request, and then take the response and aggregate it:

curl --location --request POST 'https://a.klaviyo.com/api/metric-aggregates/' \
--header 'Authorization: Klaviyo-API-Key redacted' \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--header 'revision: 2022-10-17' \
--data-raw '
{
     "data": {
          "type": "metric-aggregate",
          "attributes": {
               "measurements": [
                    "sum_value"
               ],
               "filter": [
                    "greater-or-equal(datetime,2022-11-13T00:00:00)",
                    "less-than(datetime,2022-12-13T23:59:59)",
                    "not(equals($attributed_message,\"\"))"
               ],
               "by": ["$attributed_message", "$attributed_flow"],
               "metric_id": "Wrg2NS",
               "interval": "month",
               "timezone": "EST"
          }
     }
}
' 

One other note:

• in this request, under filter , a condition is included that evaluates whether $attributed_message equals a blank string \"\".
• Eventually, the there will be added support for evaluating null. When that time comes, it may be cleaner to revise that filter condition to be: "not(equals($attributed_message,null))".

I hope this helps, and thanks for using the Community!

- Brian

Hey @Brian Turcotte!

Thanks a bunch for the explanation. Would you know what metric exactly would correspond to “Revenue From Klaviyo”? Is it a custom metric in the client’s account, or is it a default metric in Klaviyo? Or is it a filter I can apply when I query data?

Thank you,

Marie