Query pages by session
GET /sessions/${sessionId}/pages
|
Description
Retrieves the pages for a given session.
Operation
Method | GET | |||
---|---|---|---|---|
URL | /sessions/${sessionId}/pages | |||
Name | Value | Mandatory | Description | |
URI Parameters | ||||
${sessionId} | string | yes | Session identifier. | |
age | integer | no | Pages' maximum age in seconds. Older pages will not be returned. | |
include_events |
|
no | If true , the returned pages contain the reference list of associated events.
| |
include_events_detail |
|
no | If true , the returned pages contain the associated events.You can only use this parameter if include_events is set to true .
| |
url | string | no | Page URL. | |
title | string | no | Page title. | |
category | string or "all categories" | no | A specific category name or the "all categories" key, which means that the results include any page associated with a category or a combination of categories. |
<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 Page resources. |
This page was last edited on February 15, 2013, at 16:01.
Comments or questions about this documentation? Contact us for support!