Query events by page
Description
This method retrieves the events for a given page.
Request
Method | GET | |||
---|---|---|---|---|
URL | /pages/${pageId}/events | |||
Parameters | ||||
Name | Value | Mandatory | Description | |
${pageId} | string | yes | Page 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. |
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 |
This page was last edited on November 6, 2015, at 20:01.
Comments or questions about this documentation? Contact us for support!