Interface GetLogsRequest

Hierarchy

  • GetLogsRequest

Properties

fields? from? include_fields? include_totals? page? per_page? q? sort? take?

Properties

Optional fields

fields?: string

Comma-separated list of fields to include or exclude (based on value provided for include_fields) in the result. Leave empty to retrieve all fields.

Optional from

from?: string

Log Event Id from which to start selection from.

Optional include_fields

include_fields?: boolean

Whether specified fields are to be included (true) or excluded (false)

Optional include_totals

include_totals?: boolean

Return results as an array when false (default). Return results inside an object that also contains a total result count when true.

Optional page

page?: number

Page index of the results to return. First page is 0.

Optional per_page

per_page?: number

Number of results per page. Paging is disabled if parameter not sent. Default: 50. Max value: 100

Optional q

q?: string

Query in Lucene query string syntax.

Optional sort

sort?: string

Field to use for sorting appended with :1 for ascending and :-1 for descending. e.g. date:-1

Optional take

take?: number

Number of entries to retrieve when using the from parameter. Default 50, max 100

Settings

Member Visibility

Theme

On This Page