Class DashboardApi

DashboardApi - object-oriented interface

Hierarchy

BaseAPI
- DashboardApi

Index

Constructors

Properties

axios basePath configuration

Methods

Constructors

constructor

new DashboardApi(
    configuration?: Configuration,
    basePath?: string,
    axios?: AxiosInstance,
): DashboardApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns DashboardApi
Inherited from BaseAPI.constructor
- Defined in base.ts:39

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: Configuration

Methods

getDashboard

getDashboard(
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<DashboardSchema, any, {}>>
Retreive basic statistics about recent records
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<DashboardSchema, any, {}>>
Throws
- Defined in api.ts:4956