---
title: Get Events
description: "If you want to use the events data stored in Releva you can do that with this endpoint: ### Request Parameters You may perform requests to the API using the following curl equivalent: ```plain curl -H 'Content-Type: application/json' -H 'Authorization:…"
url: "https://releva.ai/documentation/events/get-events/"
updated: "2026-09-22"
category: Developer Documentation / Events
---

# Get Events

If you want to use the events data stored in Releva you can do that with this endpoint:

### Request Parameters

You may perform requests to the API using the following curl equivalent:

```plain
curl -H 'Content-Type: application/json' -H 'Authorization: Bearer <secretKey>' -XGET https://releva.ai/api/v0/events
```

### Optional Query Parameters

| Field | Type | Description |
| --- | --- | --- |
| cursor | String (Optional) | This is used for pagination when you make the first request you will have "nextCursor" inside the response and you can use it to get to the next page. |
| eventTypes | Array[String] (Optional) | This is used if you want to filter by specific event types. For example default even types that you can filter by are "pageView", "cartAdd", "cartCheckoutSuccess", etc. |
| startDateTime | [ISO-8601 String (Optional)](https://en.wikipedia.org/wiki/ISO_8601) | You can specify to get events only after the startDateTime. For example "2023-08-21T21:00:00.000Z" and it has to be escaped in the URL like this "2023-08-21T21%3A00%3A00.000Z". |
| endDateTime | [ISO-8601 String (Optional)](https://en.wikipedia.org/wiki/ISO_8601) | You can specify to get events only before the endDateTime. For example "2023-08-29T21:00:00.000Z" and it has to be escaped in the URL like this "2023-08-21T29%3A00%3A00.000Z". |

Example request with all of the parameters in it:

```plain
https://releva.ai/api/v0/events?cursor=WyIyMDIzLTA4LTIzVDA4OjU4OjM4LjA5MVoiLCJ3ZWJob29rU2VuZCJd&eventTypes[]=pageView&eventTypes[]=cartAdd&startDateTime=2023-08-21T21%3A00%3A00.000Z&endDateTime=2023-08-29T19%3A30%3A00.000Z
```

### Response Format

```
{
  "events": [
        {
            "profileId": "df4ef1f1-5528-b45e-5124-55f6c7268d65",
            "sessionId": "8fcb357c-4831-01df-78d6-4e5c2227c6af",
            "groupAssignment": "treatment",
            "pageToken": "ae94f787-583d-4621-800c-073c8d697c4e",
            "userAgent": {
                "tags": [
                    "Authoritative",
                    "Chrome",
                    "Desktop",
                    "Mac"
                ],
                "browser": "Chrome",
                "version": "115.0.0.0",
                "os": "OS X",
                "platform": "Apple Mac",
                "source": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/115.0.0.0 Safari/537.36"
            },
            "ip": "::ffff:172.20.0.11",
            "action": "pageView",
            "timestamp": "2023-08-04T10:33:37.691Z",
            "url": "http://localhost:8082/product/test-4/",
            "locale": "bg",
            "products": [
                {
                    "categories": null
                }
            ],
            "profile": {
                "firstName": "Georgi",
                "lastName": "Keranov",
                "email": "georgi.keranov@releva.ai",
                "profileId": "a6762904-42e7-a0d4-4e99-df4cb1a4bf44",
                "id": "profile/36/georgi.keranov@releva.ai"
            }
        },
        {
            "cartTotalInDomainCurrency": 26.4,
            "profileId": "1ef6da3a-a3b8-5b42-bce9-af70b8a74bb3",
            "sessionId": "e1abdb6b-b13c-90b5-76df-56d691cff438",
            "groupAssignment": "treatment",
            "userAgent": {
                "tags": [
                    "Authoritative",
                    "Chrome",
                    "Desktop",
                    "Mac"
                ],
                "browser": "Chrome",
                "version": "115.0.0.0",
                "os": "OS X",
                "platform": "Apple Mac",
                "source": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/115.0.0.0 Safari/537.36"
            },
            "ip": "::ffff:172.20.0.11",
            "timestamp": "2023-08-02T13:21:39.289Z",
            "url": "http://localhost:8082/product/test-3/",
            "locale": "bg",
            "action": "cartAdd",
            "products": [
                {
                    "id": "17",
                    "categories": [
                        "Uncategorized"
                    ],
                    "currency": "USD",
                    "locale": "bg",
                    "name": "Test 3",
                    "price": 13.2,
                    "custom": {
                        "string": [
                            {
                                "values": [
                                    "Uncategorized"
                                ],
                                "key": "category_level_1"
                            }
                        ],
                        "numeric": [
                            {
                                "values": [],
                                "key": "stock_quantity"
                            }
                        ]
                    },
                    "discount": 0,
                    "discountPercent": 0,
                    "available": true,
                    "quantity": 2,
                    "priceTotalInDomainCurrency": 26.4,
                    "priceTotal": 26.4
                }
            ],
            "priceTotalInDomainCurrency": 26.4,
            "profile": {
                "firstName": "Petar",
                "lastName": "Ivanov",
                "email": "p.ivanov@example.com",
                "profileId": "1ef6da3a-a3b8-5b42-bce9-af70b8a74bb3",
                "id": "profile/36/p.ivanov@example.com"
            }
        }
        ...
  ],
  "nextCursor": "WyIyMDIzLTA4LTIzVDA4OjU4OjM4LjA5MVoiLCJ3ZWJob29rU2VuZCJd"
}
```
