Function EventsApiFp

Returns {
    eventsCreate(
        clientEventsRequest: ClientEventsRequest,
        xOrganization?: string,
        org?: string,
        orgId?: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ClientEvents>,
    >;
    eventsList(
        action?: "download",
        filename?: string,
        from?: string,
        jobId?: number,
        orgId?: number,
        projectId?: number,
        queryId?: string,
        taskId?: number,
        to?: string,
        userId?: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
    >;
}

• eventsCreate:function

  • eventsCreate(
        clientEventsRequest: ClientEventsRequest,
        xOrganization?: string,
        org?: string,
        orgId?: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<ClientEvents>,
    >

    Sends logs to the Clickhouse if it is connected

    Parameters

    • clientEventsRequest: ClientEventsRequest
    • OptionalxOrganization: string

      Organization unique slug
    • Optionalorg: string

      Organization unique slug
    • OptionalorgId: number

      Organization identifier
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<ClientEvents>,
    >

    Throws

• eventsList:function

  • eventsList(
        action?: "download",
        filename?: string,
        from?: string,
        jobId?: number,
        orgId?: number,
        projectId?: number,
        queryId?: string,
        taskId?: number,
        to?: string,
        userId?: number,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    The log is returned in the CSV format.

    Parameters

    • Optionalaction: "download"

      Used to start downloading process after annotation file had been created
    • Optionalfilename: string

      Desired output file name
    • Optionalfrom: string

      Filter events after the datetime. If no &#39;from&#39; or &#39;to&#39; parameters are passed, the last 30 days will be set.
    • OptionaljobId: number

      Filter events by job ID
    • OptionalorgId: number

      Filter events by organization ID
    • OptionalprojectId: number

      Filter events by project ID
    • OptionalqueryId: string

      ID of query request that need to check or download
    • OptionaltaskId: number

      Filter events by task ID
    • Optionalto: string

      Filter events before the datetime. If no &#39;from&#39; or &#39;to&#39; parameters are passed, the last 30 days will be set.
    • OptionaluserId: number

      Filter events by user ID
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Throws