HomeGuidesAPI Reference
ChangelogHelp CenterCommunityContact Us
API Reference

Query Location Values

🚧

This endpoint is in beta and subject to change.

A beta revision header (2026-10-15.pre) is required to use our beta APIs. Klaviyo APIs in beta are not intended for use in production. See our versioning and deprecation policy for more information.

Get totals for a live event.

Returns how many people your campaigns for the event reached on each channel, and in-store sales during the event.

Set filter.live_event_id to the event, and set the timeframe to {"key": "all_time"}. Other timeframes aren't supported: reach always counts every campaign sent for the event, and sales always cover the event's start and end time.

To get sales for one host location, also set filter.location_id. You can't combine this filter with reach statistics.

Rate limits:
Burst: 3/s
Steady: 60/m

Scopes:
locations:read

OpenAPI Spec

Query Params
fields[location-values-report]
array of strings
fields[location-values-report]
Allowed:
Body Params

Request body for the location-values-report endpoint.

data
object
required
Headers
string
required
Defaults to 2026-10-15.pre

API endpoint revision (format: YYYY-MM-DD[.suffix])

Responses

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/vnd.api+json