Class AnalyticsService

Analytics service

Hierarchy

AnalyticsService

Index

Constructors

Properties

httpClient namespace namespaceDashboards namespaceReports

Methods

createDashboard createReport deleteDashboard deleteReport getAnalyticReport getAnalyticsReportList getDashboard getDashboardsLists updateDashboard updateReport

Constructors

constructor

new AnalyticsService(httpClient): AnalyticsService
Parameters
- httpClient: HttpClient
Returns AnalyticsService

Properties

`Private` `Readonly` httpClient

httpClient: HttpClient

`Private` namespace

namespace: string = 'analytics-backend/v1'

`Private` namespaceDashboards

namespaceDashboards: string = ...

`Private` namespaceReports

namespaceReports: string = ...

Methods

createDashboard

createDashboard(data): Promise<AxiosResponse<IDashboard, any>>
Create dashboard
Parameters
- data: Partial<IDashboard>
  
  dashboard with required title
Returns Promise<AxiosResponse<IDashboard, any>>
dashboard

createReport

createReport(data): Promise<AxiosResponse<IAnalyticReport, any>>
Create analytic report
Parameters
- data: Partial<IAnalyticReport>
  
  analytic report data without id
Returns Promise<AxiosResponse<IAnalyticReport, any>>
report

deleteDashboard

deleteDashboard(id): Promise<AxiosResponse<IDashboard, any>>
Delete dashboard
Parameters
- id: string
  
  dashboard id
Returns Promise<AxiosResponse<IDashboard, any>>

deleteReport

deleteReport(id): Promise<AxiosResponse<IAnalyticReport, any>>
Delete analytic report
Parameters
- id: string
  
  analytic report id
Returns Promise<AxiosResponse<IAnalyticReport, any>>

getAnalyticReport

getAnalyticReport(id): Promise<AxiosResponse<IAnalyticReport, any>>
Get analytic report
Parameters
- id: string
  
  analytic report id
Returns Promise<AxiosResponse<IAnalyticReport, any>>
report

getAnalyticsReportList

getAnalyticsReportList(params, signal): Promise<AxiosResponse<IAnalyticReportList, any>>
Get analytics report with filters
Parameters
- params: IAnalyticReportFilter
  
  analytics report list filter params
- signal: AbortSignal
  
  AbortSignal for cancelling request
Returns Promise<AxiosResponse<IAnalyticReportList, any>>
Array analytics report list

getDashboard

getDashboard(id): Promise<AxiosResponse<IDashboard, any>>
Get dashboard
Parameters
- id: string
  
  dashboard id
Returns Promise<AxiosResponse<IDashboard, any>>
dashboard

getDashboardsLists

getDashboardsLists(): Promise<AxiosResponse<IDashboard[], any>>
Get dashboards list

Returns Promise<AxiosResponse<IDashboard[], any>>
Array dashboards list

updateDashboard

updateDashboard(id, data): Promise<AxiosResponse<IDashboard, any>>
Update dashboard
Parameters
- id: string
  
  dashboard id
- data: Partial<IDashboard>
  
  dashboard data
Returns Promise<AxiosResponse<IDashboard, any>>
dashboard

updateReport

updateReport(id, data): Promise<AxiosResponse<IAnalyticReport, any>>
Update analytic report
Parameters
- id: string
  
  analytic report id
- data: Partial<IAnalyticReport>
  
  analytic report data
Returns Promise<AxiosResponse<IAnalyticReport, any>>
report

Generated using TypeDoc