Jump to: navigation, search

Query events by visit


This method retrieves the events for a given visit.


Method GET
URL /visits/${visitId}/events
Name Value Mandatory Description
${visitId} string yes Visit identifier.
age integer no Events' maximum age in seconds. Older events will not be returned.
eventName string no Event name.
eventType string no Event type.
category string or "all categories" no Category name or the "all categories" key, which means that the results include any event associated with a category or a combination of categories.
url string no Event URL.
browserPageID string no Browser page ID of the event, which is another page identifier unique across the visit.


The History REST API answers with HTTP codes for every request. The following table shows the correct response for a successful request. See HTTP Response Codes and Errors for further details on the possible codes that this request can return.

HTTP code 200
Body  JSON Array of Event resources.
This page was last edited on March 10, 2020, at 13:56.
Comments or questions about this documentation? Contact us for support!