Get All Events In Account for Specific Date Range and Specific Metric_ID(s)

Question

This was possible using the old version of the Python SDK however it does not appear to be possible here (or I”m missing). I’d like to grab all events in my account but only those that pertain to a certain set of metric_ids and for a specific time range. The problem with just grabbing all events is that on certain days, I’m grabbing 1million+ events which I don’t need. I’m hoping if I can narrow my query to a certain metric Id my query would take a lot less time.

Is this possible with the new version of the API?

saulblum · Accepted Answer

You mean with sparse fieldsets?https://developers.klaviyo.com/en/reference/api_overview#sparse-fieldsetsIt won’t change the Get Events rate limit but will shrink the response size, so any code calling the API might process faster with a smaller response to parse.As for properties you can fetch, forfields[event] it’s['datetime', 'event_properties', 'id', 'timestamp', 'uuid'].The ID of the event’s profile will already be returned, but you can fetch additional properties like first_name and email without having to make a separate API call to get the profile, e.g.https://a.klaviyo.com/api/events/?filter=equals(metric_id,"ABC123")&fields[profile]=email&include=profile

saulblum · Answer

You’d want to set a time range in the filter param, e.g.

klaviyo.Events.get_events(
    fields_event=['event_properties'], 
    filter="equals(metric_id,\"aBc123\"),greater-than(datetime,2023-01-01T00:00:00Z),less-than(datetime,2023-01-02T00:00:00Z)", 
    sort='-datetime'
)

Sign up

Use your Klaviyo credentials

Log in to the Community

Use your Klaviyo credentials