Jump to: navigation, search

Query pages by visit


This method retrieves the pages for a given visit.


Method GET
URL /visits/${visitId}/pages
Name Value Mandatory Description
${visitId} string yes Visit identifier.
age integer no Pages' maximum age in seconds. Older pages will not be returned.
  • true
  • false
no If true, the returned pages contain the reference list of associated events.
  • 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.


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
Body  JSON Array of Page resources.
This page was last edited on June 7, 2019, at 17:09.


Comment on this article:

blog comments powered by Disqus