Package io.goobi.viewer.api.rest.v1.statistics.usage

Class UsageStatisticsResource

java.lang.Object

io.goobi.viewer.api.rest.v1.statistics.usage.UsageStatisticsResource

@Path("/statistics/usage")
public class UsageStatisticsResource
extends Object

REST resource providing usage statistics and access metrics for records and viewer resources, covering a single day or a range of days.

Author:

Florian Alpers

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DATE_FORMAT

Constructor Summary

Constructors

Constructor	Description
UsageStatisticsResource()

Method Summary

Modifier and Type	Method	Description
Response	getStatisticsForDay(String date, String recordFilterQuery, String inFormat)
Response	getStatisticsListForDates(String start, String end, String recordFilterQuery, String inFormat, Integer step, String stepUnit)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

DATE_FORMAT

public static final String DATE_FORMAT

See Also:

• Constant Field Values

Constructor Details

UsageStatisticsResource

public UsageStatisticsResource()

Method Details

getStatisticsForDay

@GET
@Path("/{date}")
@Produces({"application/json","text/plain","text/csv"})
public Response getStatisticsForDay(@PathParam("date")
 String date,
 @QueryParam("recordFilterQuery")
 String recordFilterQuery,
 @QueryParam("format")
 String inFormat)
                             throws DAOException,
IndexUnreachableException,
PresentationException

Throws:

DAOException

IndexUnreachableException

PresentationException

getStatisticsListForDates

@GET
@Path("/{startDate}/{endDate}")
@Produces({"application/json","text/plain","text/csv"})
public Response getStatisticsListForDates(@PathParam("startDate")
 String start,
 @PathParam("endDate")
 String end,
 @QueryParam("recordFilterQuery")
 String recordFilterQuery,
 @QueryParam("format")
 String inFormat,
 @QueryParam("step")
 Integer step,
 @QueryParam("stepUnit")
 String stepUnit)
                                   throws DAOException,
IndexUnreachableException,
PresentationException

Throws:

DAOException

IndexUnreachableException

PresentationException