Class EventsApi

EventsApi - object-oriented interface

Export

Hierarchy

BaseAPI
- EventsApi

Index

Constructors

Properties

axios basePath configuration

Methods

eventsCreate eventsList

Constructors

constructor

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

Properties

`Protected` axios

axios: AxiosInstance = globalAxios

`Protected` basePath

basePath: string = BASE_PATH

`Protected` configuration

configuration: undefined | Configuration

Methods

eventsCreate

eventsCreate(requestParameters, options?): Promise<AxiosResponse<ClientEvents, any>>
Sends logs to the Clickhouse if it is connected
Parameters
- requestParameters: EventsApiEventsCreateRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<ClientEvents, any>>

Summary
Method saves logs from a client on the server

Throws

Memberof
EventsApi
- Defined in api-client/events-api.ts:404

eventsList

eventsList(requestParameters?, options?): Promise<AxiosResponse<void, any>>
Receive logs from the server
Parameters
- requestParameters: EventsApiEventsListRequest = {}
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<void, any>>

Summary
Method returns csv log file

Throws

Memberof
EventsApi
- Defined in api-client/events-api.ts:416

Generated using TypeDoc