Analytics | @tillhub/javascript-sdk

Hierarchy

ThBaseHandler
- Analytics

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Analytics(options: AnalyticsOptions, http: Client): Analytics

Overrides ThBaseHandler.constructor
- Defined in src/v4/analytics.ts:64
Parameters
- options: AnalyticsOptions
- http: Client
Returns Analytics

Properties

endpoint

endpoint: string

http

http: Client

options

options: AnalyticsOptions

uriHelper

uriHelper: UriHelper

Static baseEndpoint

baseEndpoint: string = '/api/v4/analytics'

Methods

getCartItemsAverage

getCartItemsAverage(query?: AnalyticsQuery): Promise<AnalyticsResponse>

- Defined in src/v4/analytics.ts:214
Parameters
- Optional query: AnalyticsQuery
Returns Promise<AnalyticsResponse>

getOpenPurchaseOrdersCount

getOpenPurchaseOrdersCount(query?: AnalyticsQuery): Promise<AnalyticsResponse>

- Defined in src/v4/analytics.ts:154
Parameters
- Optional query: AnalyticsQuery
Returns Promise<AnalyticsResponse>

getOpenPurchaseOrdersExpense

getOpenPurchaseOrdersExpense(query?: AnalyticsQuery): Promise<AnalyticsResponse>

- Defined in src/v4/analytics.ts:169
Parameters
- Optional query: AnalyticsQuery
Returns Promise<AnalyticsResponse>

getProductsReturnRate

getProductsReturnRate(query?: AnalyticsQuery): Promise<AnalyticsResponse>

- Defined in src/v4/analytics.ts:184
Parameters
- Optional query: AnalyticsQuery
Returns Promise<AnalyticsResponse>

getProductsTopGroups

getProductsTopGroups(query?: AnalyticsQuery): Promise<AnalyticsResponse>

- Defined in src/v4/analytics.ts:199
Parameters
- Optional query: AnalyticsQuery
Returns Promise<AnalyticsResponse>

getRevenue

getRevenue(query?: AnalyticsQuery): Promise<AnalyticsResponse>

- Defined in src/v4/analytics.ts:79
Parameters
- Optional query: AnalyticsQuery
Returns Promise<AnalyticsResponse>

getRevenueAverage

getRevenueAverage(query?: AnalyticsQuery): Promise<AnalyticsResponse>

- Defined in src/v4/analytics.ts:94
Parameters
- Optional query: AnalyticsQuery
Returns Promise<AnalyticsResponse>

getRevenuePaymentTypes

getRevenuePaymentTypes(query?: AnalyticsQuery): Promise<AnalyticsResponse>

- Defined in src/v4/analytics.ts:124
Parameters
- Optional query: AnalyticsQuery
Returns Promise<AnalyticsResponse>

getRevenueTopProducts

getRevenueTopProducts(query?: AnalyticsRevenueTopProductsQuery): Promise<AnalyticsResponse>

- Defined in src/v4/analytics.ts:109
Parameters
- Optional query: AnalyticsRevenueTopProductsQuery
Returns Promise<AnalyticsResponse>

getRevenueTopStaff

getRevenueTopStaff(query?: AnalyticsQuery): Promise<AnalyticsResponse>

- Defined in src/v4/analytics.ts:139
Parameters
- Optional query: AnalyticsQuery
Returns Promise<AnalyticsResponse>

Generated using TypeDoc