Jump to: navigation, search

Query pages by visit

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

Description

Retrieves the pages for a given visit.

Operation

Method GET
URL /visits/${visitId}/pages
Name   Value Mandatory Description
URI Parameters
${visitId} string yes Visit 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 used to filter the results.
title string no Page title used to filter the results.
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.
browserPageID string no Browser page id, which is another page identifier unique across the visit. A collection with maximum one page will be returned.

<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 modified on February 15, 2013, at 09:01.

Feedback

Comment on this article:

blog comments powered by Disqus