Query event property values

Returns the values a brand's events hold for the given event properties,
using cursor paging.

Filtering:
eventName and eventOrigin are both required and select the event to read:
values are stored per origin, so a read always covers a single one.
properties names 1-10 property paths to read the values of, such as
contact.email or order.currency.

Supported events:
eventName accepts one of the standard events below; brand-custom events
are not readable.

  • subscribed to marketing
  • unsubscribed from marketing
  • opted-in for promotions
  • opted-out from promotions
  • message sent
  • opened message
  • clicked message
  • marked message as spam
  • message delivery failed

Values:
Only the string leaves of an event payload are collected, so numbers,
booleans, objects and arrays have no values to return. A property path
that was never collected is not an error: it is returned as an empty
array. The response echoes eventName and eventOrigin the values belong
to.

Paging:
limit (1-1000, default 100) caps the page size and counts the values of
all requested properties together. after continues a previous page and
must be sent with the same filters that page was read with. Values are
grouped per property and ordered alphabetically inside a group rather than
across the page.
Paging is forward-only, so paging.cursors.after is null on the last page.

Scopes:
events.read

Rate Limiting:
This endpoint is rate limited to 20 requests per minute.

Body Params

Filters and paging parameters

Request body for POST /events/property-values/query.

string

Cursor from the previous page, sent together with that page's filters.

string
required

Event name to read the property values of.

string
required

Origin of the event to read the property values of.

integer
1 to 1000

Page size (1-1000, default 100).

properties
array of strings
required
length between 1 and 10

Property paths to read the values of (1-10).

properties*
Headers
string
required
Defaults to 2026-preview

API version that specifies the response format and behaviour

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json