Events

Retrieve events

Returns the list of events such as clicks, page visits or inputs contained in a particular session recording. These are high-level (indexed) events that can be searched in OpenReplay app.

Method

GET

URL

/api/v1/:projectKey/sessions/:sessionId/events

Parameters

Name	Type	Description
projectKey	string	The ID of the project you're tracking (required)
sessionId	string	The ID of the session from which you're pulling the events (required)

Request Headers

Authorization: {YOUR_ORGANIZATION_API_KEY}: The key can be found in 'Preferences' > 'Account' > 'Organization API Key'.

Status Codes

200: Response sent as JSON in body

Example Request

curl -X GET \
  https://openreplay.example.com/api/v1/3sWXSsqHgSKnE87YkNJK/sessions/4813023023591169/events \
  -H 'content-type: application/json' \
  -H 'Authorization: {YOUR_ORGANIZATION_API_KEY}'

Example Response

{
    "data": [{
        "sessionId": 4813023023591169,
        "messageId": 4294969053,
        "timestamp": 1623440905732,
        "host": "testsite.openreplay.com",
        "path": "/my-account/",
        "basePath": "/my-account/",
        "referrer": "https://testsite.openreplay.com/",
        "baseReferrer": "https://testsite.openreplay.com/",
        "domBuildingTime": null,
        "domContentLoadedTime": null,
        "loadTime": null,
        "firstPaintTime": null,
        "firstContentfulPaintTime": null,
        "speedIndex": null,
        "visuallyComplete": null,
        "timeToInteractive": null,
        "responseTime": null,
        "responseEnd": null,
        "ttfb": null,
        "value": "/my-account/",
        "url": "/my-account/",
        "type": "LOCATION"
    }, {
        "sessionId": 4813023023591169,
        "messageId": 17179871001,
        "timestamp": 1623440915126,
        "label": "Shop",
        "type": "CLICK"
    }, {
        "sessionId": 4813023023591169,
        "messageId": 25769806952,
        "timestamp": 1623440919928,
        "host": "testsite.openreplay.com",
        "path": "/product/beanie-with-logo/",
        "basePath": "/product/beanie-with-logo/",
        "referrer": "https://testsite.openreplay.com/shop/",
        "baseReferrer": "https://testsite.openreplay.com/shop/",
        "domBuildingTime": null,
        "domContentLoadedTime": null,
        "loadTime": null,
        "firstPaintTime": null,
        "firstContentfulPaintTime": null,
        "speedIndex": null,
        "visuallyComplete": null,
        "timeToInteractive": null,
        "responseTime": null,
        "responseEnd": null,
        "ttfb": null,
        "value": "/product/beanie-with-logo/",
        "url": "/product/beanie-with-logo/",
        "type": "LOCATION"
    }]
}

Assist

Jobs