1.41 Nutzungszahlen

Der Goobi viewer kann von sich aus Nutzungszahlen zu einzelnen Datensätzen ermitteln. Ermittelt werden kann dabei:

absolute Zahl der Seitenansichten (jeder Aufruf einer Seite eines Werkes)
eindeutigen Seitenansichten (jeder Aufruf einer Seite eines Werkes wird pro Nutzersession nur einmal gezählt)
absolute Zahl der Downloads (jeder Download einer Datei)
eindeutige Downloads (jeder Download einer Datei wird pro Nutzersession nur einmal gezählt)

Eine Nutzersession ist dabei die Session aus Sicht des Goobi viewers.

Die Logik dabei ist, dass alle Aufrufe die ein Werk öffnen einer Datenbank zwischengespeichert werden. Volle Tage können dann in den Solr Suchindex übertragen werden. Sobald die Daten im Suchindex stehen können sie entweder in einem Widget angezeigt oder über die REST API abgerufen werden.

Für die Konfiguration stehen folgende Einstellmöglichkeiten zur Verfügung:

<statistics enabled="false">
    <crawlerDetection regex=".*[bB]ot.*|.*Yahoo! Slurp.*|.*Feedfetcher-Google.*|.*Apache-HttpClient.*|.*[Ss]pider.*|.*[Cc]rawler.*|.*nagios.*|.*Yandex.*|.*monitoring-plugins.*|.*node-fetch.*|.*Munin.*|.*SearchHelper.*|.*Qwantify.*|.*feedparser.*|.*Prefetch Proxy.*|.*internal dummy connection.*|.*Go-http-client.*|.*facebookexternalhit.*|^.?$|.*Dataprovider.com.*|.*TYPO3.*|.*python.*|.*curl.*|.*LinkAnalyser.*|.*GuzzleHttp.*|.*Spawning-AI.*|.*Iframely.*|.*ApacheBench.*|.*deadlinkchecker.*|.*Fingerprinter.*|.*Riddler.*|.*Java-http.*" />
</statistics>

Mit dem Attribut enabled wird die Funktionalität ein- oder ausgeschaltet. Ist sie aktiv, wird - sofern Daten vorliegen - auch ein Widget in der Seitenleiste angezeigt, das die Nutzungszahlen anzeigt.

Mit dem regulären Ausdruck im Element crawlerDetection wird definiert, welche UserAgents als Suchmaschinen behandelt werden. Diese werden nicht mitgezählt.

Für die Abfrage der Nutzungszahlen stehen die folgenden beiden REST Endpoints zur Verfügung:

Get usage statistics for a single day

get

/statistics/usage/{date}

Path parameters

datestringrequired

date to observe, in format yyyy-mm-dd

Query parameters

recordFilterQuerystring

additional SOLR query to filter records which should be counted. Only requests to records matching the query will be counted

formatstring

the format in which to return the data. May be json, text or csv. Default is json

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://viewer.goobi.io/api/v1/statistics/usage/{date}'

default

application/json

text/plain

text/csv

No body

default response

Get a list of usage statistics for a time frame

get

/statistics/usage/{startDate}//{endDate}

Path parameters

startDatestringrequired

first date to observer, in format yyyy-mm-dd

endDatestringrequired

last date to observer, in format yyyy-mm-dd