history.getVisits()

{{AddonSidebar}} 

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 ``{{WebExtAPIRef(‘history.VisitItem’)}}  objects each representing a visit to the given URL. Visits are sorted in reverse chronological order.

Browser compatibility

{{Compat}} 

Examples

List all visits to the most recently-visited page:

function gotVisits(visits) {
  console.log(`Visit count: ${visits.length}`);
  for (const visit of visits) {
    console.log(visit.visitTime);
  }
}

function listVisits(historyItems) {
  if (historyItems.length) {
    console.log(`URL ${historyItems[0].url}`);
    const gettingVisits = browser.history.getVisits({
      url: historyItems[0].url,
    });
    gettingVisits.then(gotVisits);
  }
}

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

searching.then(listVisits);

{{WebExtExamples}} 

[!NOTE] This API is based on Chromium’s chrome.history API. This documentation is derived from history.json in the Chromium code.