Skip to main content
Version: Next

VisitsApi

Home > @backstage/plugin-home > VisitsApi

Visits API public contract.

Signature:

export interface VisitsApi 

Methods

Method

Description

canSave(visit)?

(Optional) Determine whether a visit should be saved.

enrichVisit(visit)?

(Optional) Add additional data to the visit before saving.

list(queryParams)

Get user visits.

save(saveParams)

Persist a new visit.

transformPathname(pathname)?

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