Skip to main content
Version: Next

VisitsStorageApi

Home > @backstage/plugin-home > VisitsStorageApi

This is an implementation of VisitsApi that relies on a StorageApi. Beware that filtering and ordering are done in memory therefore it is prudent to keep limit to a reasonable size.

Signature:

class VisitsStorageApi implements VisitsApi 

Implements: VisitsApi

Methods

Method

Modifiers

Description

canSave(visit)

Determine whether a visit should be saved.

create(options)

static

enrichVisit(visit)

Add additional data to the visit before saving.

list(queryParams)

Returns a list of visits through the visitsApi

save(saveParams)

Saves a visit through the visitsApi

transformPathname(pathname)

Transform the pathname before it is considered for any other processing.