Class EventsApi

EventsApi - object-oriented interface

Export

EventsApi

Hierarchy

BaseAPI
- EventsApi

Index

Constructors

Properties

axios basePath configuration

Methods

eventsCreate eventsList

Constructors

constructor

new EventsApi(
    configuration?: Configuration,
    basePath?: string,
    axios?: AxiosInstance,
): EventsApi
Parameters
- Optionalconfiguration: 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: EventsApiEventsCreateRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<ClientEvents, any>>
Sends logs to the Clickhouse if it is connected
Parameters
- requestParameters: EventsApiEventsCreateRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ClientEvents, any>>
Throws
Memberof
EventsApi
- Defined in api-client/events-api.ts:407

eventsList

eventsList(
requestParameters?: EventsApiEventsListRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any>>
The log is returned in the CSV format.
Parameters
- requestParameters: EventsApiEventsListRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Throws
Memberof
EventsApi
- Defined in api-client/events-api.ts:419