Skip to content

Area: Developers

GET

List events

Path
/events
Auth
Secret key · server only
GET
/events
curl --request GET \
--url 'https://releva.ai/api/v0/events?eventTypes%5B%5D=wishlistAdd&eventTypes%5B%5D=search&startDateTime=2026-10-21T00%3A00%3A00Z&endDateTime=2026-10-22T00%3A00%3A00Z' \
--header 'Authorization: Bearer <token>'

Returns the domain’s tracked events from every source (SDK, server events, searches, subscriptions, carts), newest first, 10 per page. nextCursor is present only when the page holds 10 events. Known issue (verified 2026-10-21): events inside a page are not sorted and the cursor is taken from the last element of the page, so consecutive pages can repeat or skip events. De-duplicate on the client.

eventTypes[]
Array<string>

Filter on action. Repeat the parameter (eventTypes[]=a&eventTypes[]=b). A plain eventTypes=a is rejected.

Example

?eventTypes%5B%5D=wishlistAdd&eventTypes%5B%5D=search
startDateTime

ISO-8601 date-time with seconds and a timezone offset (Z, +0300 or +03:00), optional milliseconds.

string
/^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{3})?(Z|[+-]\d{2}:?\d{2})$/

Inclusive lower bound. URL-encode : and + (%2B).

Example

2026-10-21T00:00:00Z
endDateTime

ISO-8601 date-time with seconds and a timezone offset (Z, +0300 or +03:00), optional milliseconds.

string
/^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{3})?(Z|[+-]\d{2}:?\d{2})$/

Exclusive upper bound.

Example

2026-10-22T00:00:00Z
cursor
string

The nextCursor of the previous page. Any other value answers 500.

One page of events.

Media typeapplication/json
object
events
required
Array<object>
<= 10 items

An event as stored. Empty values are omitted. Browser events also carry sessionId, deviceId, pageToken, groupAssignment, ip and url.

object
action
string
timestamp
string format: date-time
profileId

profile/<domainId>/<profile id>.

string
id

Same value as profileId.

string
domainId
string
locale
string
location

[longitude, latitude].

Array<number>
tags
Array<string>
products
Array<object>
object
key
additional properties
any
cartTotalInDomainCurrency
number
custom

Custom attributes, usable in segments.

object
string
Array<object>
object
key
required
string
values
required
Array<string>
numeric
Array<object>
object
key
required
string
values
required
Array<number>
date
Array<object>
object
key
required
string
values
required
Array<string>
filter

Search events only. The filter object serialised as JSON.

string
ingestedAt

UTC, YYYY-MM-DD HH:mm:ss.SSS.

string
userAgent
object
key
additional properties
any
groupAssignment
string
ip
string
url
string
sessionId
string
deviceId
string
pageToken
string
profile

The profile row (about 40 fields, including e-mail, phone, names, tags, subscriptions and bounce dates). Absent when the profile no longer exists.

object
key
additional properties
any
key
additional properties
any
nextCursor

Present only when the page has 10 events.

string

Example

{
"events": [
{
"userAgent": {},
"profileId": "profile/15/DEMO-CUST-1001",
"domainId": "15",
"action": "wishlistAdd",
"timestamp": "2026-10-21T09:15:00.000Z",
"locale": "en",
"location": [
0,
0
],
"tags": [
"wishlist"
],
"products": [
{
"available": true,
"categories": [
"Men/Shirts",
"Summer"
],
"currency": "EUR",
"id": "DEMO-1001",
"locale": "en",
"name": "Linen Summer Shirt",
"price": 39.9,
"priceTotalInDomainCurrency": 39.9,
"quantity": 1,
"sku": "DEMO-1001-M",
"custom": {
"string": [
{
"key": "size",
"values": [
"M"
]
},
{
"key": "brand",
"values": [
"Demo Basics"
]
}
],
"numeric": [],
"date": []
}
}
],
"cartTotalInDomainCurrency": 39.9,
"ingestedAt": "2026-10-20 21:56:43.000",
"custom": {
"string": [
{
"key": "source",
"values": [
"product-page"
]
}
],
"numeric": [
{
"key": "position",
"values": [
2
]
}
],
"date": []
},
"profile": {
"domainId": "15",
"firstName": "Maria",
"lastName": "Example",
"email": "maria@example.com",
"id": "profile/15/DEMO-CUST-1001"
},
"id": "profile/15/DEMO-CUST-1001"
}
]
}

Authentication or query validation error.

Media typeapplication/json
object
message
required

Human-readable error. Several validation errors are joined with a space.

string

Examples

{
"message": "The 'eventTypes' field must be an array."
}

The domain is disabled.

Media typeapplication/json
object
message
required

Human-readable error. Several validation errors are joined with a space.

string

Example

{
"message": "Domain is disabled. Please reach out to support@releva.ai to enable it."
}

Unexpected server error.

Media typeapplication/json
object
message
required

Human-readable error. Several validation errors are joined with a space.

string

Example

{
"message": "An internal error occurred."
}