Class LogsListRequest

Object to send with the request to retrieve a list of logs from your Organization.

Hierarchy

  • LogsListRequest

Constructors

constructor

Properties

additionalProperties? index? limit? query? sort? startAt? time

Constructors

constructor

Properties

Optional additionalProperties

additionalProperties?: {
    [key: string]: any;
}

A container for additional, undeclared properties. This is a holder for any undeclared properties as specified with the 'additionalProperties' keyword in the OAS document.

Type declaration

  • [key: string]: any

Optional index

index?: string

The log index on which the request is performed. For multi-index organizations, the default is all live indexes. Historical indexes of rehydrated logs must be specified.

Optional limit

limit?: number

Number of logs return in the response.

Optional query

query?: string

The search query - following the log search syntax.

Optional sort

sort?: v1.LogsSort

Time-ascending asc or time-descending desc results.

Optional startAt

startAt?: string

Hash identifier of the first log to return in the list, available in a log id attribute. This parameter is used for the pagination feature.

Note: This parameter is ignored if the corresponding log is out of the scope of the specified time window.

time

time: LogsListRequestTime

Timeframe to retrieve the log from.

Settings

Member Visibility

Theme

Generated using TypeDoc