Function EventsApiAxiosParamCreator

  • EventsApi - axios parameter creator

    Parameters

    Returns {
        eventsCreate: ((clientEventsRequest, xOrganization?, org?, orgId?, options?) => Promise<RequestArgs>);
        eventsList: ((action?, filename?, from?, jobId?, orgId?, projectId?, queryId?, taskId?, to?, userId?, options?) => Promise<RequestArgs>);
    }

    • eventsCreate: ((clientEventsRequest, xOrganization?, org?, orgId?, options?) => Promise<RequestArgs>)
        • (clientEventsRequest, xOrganization?, org?, orgId?, options?): Promise<RequestArgs>
        • Sends logs to the Clickhouse if it is connected

          Parameters

          • clientEventsRequest: ClientEventsRequest
          • Optional xOrganization: string

            Organization unique slug

          • Optional org: string

            Organization unique slug

          • Optional orgId: number

            Organization identifier

          • Optional options: AxiosRequestConfig<any> = {}

            Override http request option.

          Returns Promise<RequestArgs>

          Summary

          Method saves logs from a client on the server

          Throws

    • eventsList: ((action?, filename?, from?, jobId?, orgId?, projectId?, queryId?, taskId?, to?, userId?, options?) => Promise<RequestArgs>)
        • (action?, filename?, from?, jobId?, orgId?, projectId?, queryId?, taskId?, to?, userId?, options?): Promise<RequestArgs>
        • Receive logs from the server

          Parameters

          • Optional action: "download"

            Used to start downloading process after annotation file had been created

          • Optional filename: string

            Desired output file name

          • Optional from: 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.

          • Optional jobId: number

            Filter events by job ID

          • Optional orgId: number

            Filter events by organization ID

          • Optional projectId: number

            Filter events by project ID

          • Optional queryId: string

            ID of query request that need to check or download

          • Optional taskId: number

            Filter events by task ID

          • Optional to: 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.

          • Optional userId: number

            Filter events by user ID

          • Optional options: AxiosRequestConfig<any> = {}

            Override http request option.

          Returns Promise<RequestArgs>

          Summary

          Method returns csv log file

          Throws

    Export

Generated using TypeDoc