Class ReportService

Index

Constructors

Properties

Methods

getPageviewReports getRefundReports getReports getSalesReports getTotalReports

Constructors

constructor

new ReportService(adapter: AuthenticatedAdapter): ReportService
Parameters
- adapter: AuthenticatedAdapter
Returns ReportService
- Defined in src/services/ReportService.ts:4

Properties

`Protected` `Readonly`adapter

adapter: AuthenticatedAdapter

Methods

getPageviewReports

getPageviewReports(): Promise<unknown>
Get the page view reports. Untested

Returns Promise<unknown>

See
https://devdocs.magento.com/marketplace/eqp/v1/users.html#user-reports
- Defined in src/services/ReportService.ts:12

getRefundReports

getRefundReports(): Promise<unknown>
Get the reports about refunds. Untested

Returns Promise<unknown>

See
https://devdocs.magento.com/marketplace/eqp/v1/users.html#user-reports
- Defined in src/services/ReportService.ts:42

getReports

getReports(metricName?: string): Promise<unknown>
Get all reports or only a specific one Untested
Parameters
- OptionalmetricName: string
Returns Promise<unknown>
See
- https://devdocs.magento.com/marketplace/eqp/v1/reports.html
- https://devdocs.magento.com/marketplace/eqp/v1/users.html#user-reports
- Defined in src/services/ReportService.ts:52

getSalesReports

getSalesReports(): Promise<unknown>
Get the sales report. Untested

Returns Promise<unknown>

See
https://devdocs.magento.com/marketplace/eqp/v1/users.html#user-reports
- Defined in src/services/ReportService.ts:32

getTotalReports

getTotalReports(): Promise<unknown>
Get the totals of all reports. Untested

Returns Promise<unknown>

See
https://devdocs.magento.com/marketplace/eqp/v1/users.html#user-reports
- Defined in src/services/ReportService.ts:22