Class: AnalyticsService
Defined in: backends/web-backend/src/analytics/analytics.service.ts:102
Implements
OnModuleInitOnModuleDestroy
Constructors
Constructor
new AnalyticsService(
eventModel,dailyModel,campaignModel,visitModel,userModel,projectModel,workbookModel,posWorkbookModel,sessions):AnalyticsService
Defined in: backends/web-backend/src/analytics/analytics.service.ts:105
Parameters
eventModel
Model<UsageEventDocument>
dailyModel
Model<Document<unknown, { }, DailyAggregate, { }, { }> & DailyAggregate & object & object>
campaignModel
Model<CampaignDocument>
visitModel
Model<CampaignVisitDocument>
userModel
Model<Document<unknown, { }, User, { }, { }> & User & object & object>
projectModel
Model<Document<unknown, { }, Project, { }, { }> & Project & object & object>
workbookModel
Model<WorkbookDocument>
posWorkbookModel
Model<PosWorkbookDocument>
sessions
Returns
AnalyticsService
Methods
createCampaign()
createCampaign(
input,actor):Promise<Record<string,unknown>>
Defined in: backends/web-backend/src/analytics/analytics.service.ts:252
Parameters
input
destinationPath?
string
expiresAt?
string | null
name?
string
actor
string
Returns
Promise<Record<string, unknown>>
dashboard()
dashboard(
query):Promise<Record<string,unknown>>
Defined in: backends/web-backend/src/analytics/analytics.service.ts:291
Parameters
query
Returns
Promise<Record<string, unknown>>
dashboardCsv()
dashboardCsv(
query):Promise<string>
Defined in: backends/web-backend/src/analytics/analytics.service.ts:360
Parameters
query
Returns
Promise<string>
ingest()
ingest(
events,context):Promise<{accepted:number; }>
Defined in: backends/web-backend/src/analytics/analytics.service.ts:133
Parameters
events
context
EventContext
Returns
Promise<{ accepted: number; }>
listAdminUsers()
listAdminUsers():
Promise<Record<string,unknown>[]>
Defined in: backends/web-backend/src/analytics/analytics.service.ts:373
Returns
Promise<Record<string, unknown>[]>
listCampaigns()
listCampaigns():
Promise<Record<string,unknown>[]>
Defined in: backends/web-backend/src/analytics/analytics.service.ts:277
Returns
Promise<Record<string, unknown>[]>
onModuleDestroy()
onModuleDestroy():
void
Defined in: backends/web-backend/src/analytics/analytics.service.ts:129
Returns
void
Implementation of
OnModuleDestroy.onModuleDestroy
onModuleInit()
onModuleInit():
Promise<void>
Defined in: backends/web-backend/src/analytics/analytics.service.ts:117
Returns
Promise<void>
Implementation of
OnModuleInit.onModuleInit
openCampaign()
openCampaign(
token,visitorIdInput):Promise<{destinationPath:string;name:string;token:string; }>
Defined in: backends/web-backend/src/analytics/analytics.service.ts:220
Parameters
token
string
visitorIdInput
string
Returns
Promise<{ destinationPath: string; name: string; token: string; }>
recordAccountCreated()
recordAccountCreated(
user,campaignToken?,visitorId?):Promise<void>
Defined in: backends/web-backend/src/analytics/analytics.service.ts:192
Parameters
user
Document<unknown, { }, User, { }, { }> & User & object & object
campaignToken?
string
visitorId?
string
Returns
Promise<void>
recordProjectCreated()
recordProjectCreated(
input):Promise<void>
Defined in: backends/web-backend/src/analytics/analytics.service.ts:204
Parameters
input
projectId
string
projectType
string
userId
string
username
string
Returns
Promise<void>
recordWorkbookCreated()
recordWorkbookCreated(
input):Promise<void>
Defined in: backends/web-backend/src/analytics/analytics.service.ts:212
Parameters
input
projectId
string
projectType
string
technicalElement
string
userId
string
username
string
workbookId
string
Returns
Promise<void>
setAdmin()
setAdmin(
userId,isAdmin,actor):Promise<void>
Defined in: backends/web-backend/src/analytics/analytics.service.ts:386
Parameters
userId
string
isAdmin
boolean
actor
EventContext
Returns
Promise<void>
setCampaignActive()
setCampaignActive(
id,active):Promise<Record<string,unknown>>
Defined in: backends/web-backend/src/analytics/analytics.service.ts:269
Parameters
id
string
active
boolean
Returns
Promise<Record<string, unknown>>