web_extensions / latest / api / history / getvisits.html /

history.getVisits()

Retrieves information about all visits to the given URL.

This is an asynchronous function that returns a Promise.

Syntax

let getting = browser.history.getVisits(
  details                // object
)

Parameters

details

An object with the following properties:

url

string. The URL for which to retrieve visit information.

Return value

A Promise will be fulfilled with an array of history.VisitItem objects each representing a visit to the given URL. Visits are sorted in reverse chronological order.

Browser compatibility

Desktop Mobile
Chrome Edge Firefox Internet Explorer Opera Safari WebView Android Chrome Android Firefox for Android Opera Android Safari on IOS Samsung Internet
getVisits
Yes
79
50
?
Yes
No
?
?
No
?
No
?

Examples

List all visits to the most recently-visited page:

function gotVisits(visits) {
  console.log("Visit count: " + visits.length);
  for (visit of visits) {
    console.log(visit.visitTime);
  }
}

function listVisits(historyItems) {
  if (historyItems.length) {
    console.log("URL " + historyItems[0].url);
    let gettingVisits = browser.history.getVisits({
      url: historyItems[0].url
    });
    gettingVisits.then(gotVisits);
  }
}

let searching = browser.history.search({
  text: "",
  startTime: 0,
  maxResults: 1
});

searching.then(listVisits);

Note: This API is based on Chromium's chrome.history API. This documentation is derived from history.json in the Chromium code.

Microsoft Edge compatibility data is supplied by Microsoft Corporation and is included here under the Creative Commons Attribution 3.0 United States License.

© 2005–2022 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/history/getVisits