Jump to: navigation, search

Query events by visit

Description

This method retrieves the events for a given visit.

Request

Method GET
URL /visits/${visitId}/events
Parameters
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.

Response

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
HTTP Title OK
Body  JSON Array of Event resources.

Feedback

Comment on this article:

blog comments powered by Disqus
This page was last modified on November 6, 2015, at 12:00.