API Docs

Invenio module for collecting statistics.

class invenio_stats.ext.InvenioStats(app=None, **kwargs)

Invenio-Stats extension.

Extension initialization.

init_app(app, entry_point_group_events='invenio_stats.events', entry_point_group_aggs='invenio_stats.aggregations', entry_point_group_queries='invenio_stats.queries')

Flask application initialization.

init_config(app)

Initialize configuration.

(task)invenio_stats.tasks.process_events(event_types)

Index statistics events.

(task)invenio_stats.tasks.aggregate_events(aggregations, start_date=None, end_date=None, update_bookmark=True)

Aggregate indexed events.

Signal receivers for certain events.

invenio_stats.contrib.event_builders.build_file_unique_id(doc)

Build file unique identifier.

invenio_stats.contrib.event_builders.build_record_unique_id(doc)

Build record unique identifier.

invenio_stats.contrib.event_builders.file_download_event_builder(event, sender_app, obj=None, **kwargs)

Build a file-download event.

invenio_stats.contrib.event_builders.record_view_event_builder(event, sender_app, pid=None, record=None, **kwargs)

Build a record-view event.