Jump to: navigation, search

Query pages by session

Description

This method retrieves the pages for a given session.

Request

Method GET
URL /sessions/${sessionId}/pages
Parameters
Name Value Mandatory Description
${sessionId} string yes Session identifier.
age integer no Pages' maximum age in seconds. Older pages will not be returned.
include_events
  • true
  • false
no If true, the returned pages contain the reference list of associated events.
include_events_detail
  • true (if include_events="true")
  • false
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.

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 Page resources.

Feedback

Comment on this article:

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