pm4py.algo.connectors.variants.firefox_history module#

PM4Py – A Process Mining Library for Python Copyright (C) 2026 Process Intelligence Solutions GmbH

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see this software project’s root or visit <https://www.gnu.org/licenses/>.

Website: https://processintelligence.solutions Contact: info@processintelligence.solutions

class pm4py.algo.connectors.variants.firefox_history.Parameters(*values)[source]#

Bases: Enum

Enum container for optional apply parameters.

HISTORY_DB_PATH = 'history_db_path'#
pm4py.algo.connectors.variants.firefox_history.apply(parameters: Dict[Any, str] | None = None) → DataFrame[source]#

Extract an event log from one or more places.sqlite files.

The function can be pointed either at a specific places.sqlite file or at the Profiles directory containing multiple profile folders. If a directory is given, a separate case identifier is generated for every profile found.

Attributes created per event (column → description)#

  • case:concept:name – Identifier of the Firefox profile folder (or “DEFAULT” when a single DB path is supplied). Serves as case ID in process-mining terminology.

  • concept:name – Canonicalised URL path (protocol/query stripped). Acts as activity label for each event.

  • time:timestamp – Python datetime converted from Firefox’s PRTime (microseconds since Unix epoch).

  • complete_url – Full URL including scheme and query string, suitable when the exact navigation target is important.

  • domain – Registered domain portion of the URL; helps grouping visits by site.

  • url_wo_parameters – Same as concept:name but kept separately for convenience when the activity label gets renamed downstream.

  • title – Page title stored by Firefox (from moz_places.title). Note: may be NULL for some automatic loads or download links.

  • visit_type – Raw integer from moz_historyvisits.visit_type. Referential value for advanced analysis.

  • visit_type_desc – Human-friendly label mapped from visit_type via VISIT_TYPE_MAP (e.g., “TYPED”, “BOOKMARK”, “RELOAD”).

  • session_id – Numeric identifier grouping visits that happened within the same browser session (i.e., between Firefox startups).

  • from_visit – visit_id of the referrer visit inside the same database – enables reconstruction of click chains within a tab.

  • visit_count_place – Cumulative counter how often the place (URL) has been visited overall up to the current record.

  • typed – True when the user explicitly typed/pasted the address (moz_places.typed > 0). Often correlates with intentional navigations.

  • frecency – Firefox’s scoring metric combining frequency and recency; higher numbers indicate pages likely to appear as top results in the address bar.

  • guid – Stable 12-character base-62 GUID uniquely identifying the place entry – useful as a surrogate key when merging logs.

returns:

Chronologically sorted event log ready for process-mining libraries.

rtype:

pandas.DataFrame