Jump to: navigation, search

Query events by visit

ApiRef2.png
GET /visits/${visitId}/events

Description

Retrieves the events for a given visit.

Operation

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

<references />

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 operation can return.

HTTP code 200
HTTP Title OK
Body  JSON Array of Event resources.









This page was last edited on February 15, 2013, at 16:01.
Comments or questions about this documentation? Contact us for support!