Skip to main content

Get logs list

Get logs list. Available events:

System

  • successful_login_api_call
  • incorrect_login_api_call

Access

  • access_granted_by_valid_identifier
  • access_denied_by_not_valid_identifier
  • access_denied_by_unknown_identifier
  • access_granted_by_api_call
  • lift_called_to_floor
Query Parameters
  • locale string

    Possible values: [en, ru, uk]

    Language for localizing logs. Value by default is 'en'

  • from integer

    Unix time

  • to integer

    Unix time

  • limit integer required

    Possible values: [10, 20, 30, 50]

    Default value: 10

    Number of items. Value by default is 10

  • page_number integer required

    Possible values: >= 1

    Default value: 1

    Page number

  • order_by string

    sorting expression:

    [field name 1], [field name 2]... <order (asc or desc)>

  • filter string

    Filtering expression:

    [field name] [compare operator] [value] <logical operator>...

    field namesee the list of available fields in filter.available_fields[].field_name
    valuesee the list of available values in filter.available_fields[].options object, may be missing
    compare operatorsee the list of available operators in filter.available_fields[].compare_operators array
    Compare operatorsDescriptionExample
    eqEqualname eq 'Sherlock Holmes'
    gtGreater thanbuilding gt 10
    ltLess thanbuilding lt 10
    nqNot equalname nq 'Sherlock Holmes'
    geGreater than or equalfloor ge 5
    leLess than or equalfloor le 5
    Logical operators
    andlogical ANDfloor le 10 and floor gt 3
    orlogical ORfloor le 3 or floor gt 10
    notlogical NOTnot floor le 3
    group operations
    ()group by priority(name eq 'Sherlock Holmes' or building eq 221) and floor gt 10
Responses

OK


Schema
  • list_option object[]
  • pagination object

    Available pagination options for tables

  • total_items integer

    The total number of items found and reflected across all pages

  • items_limit integer

    Possible values: [10, 25, 50]

    Limiting the display of the amount of data for one page

  • total_pages integer

    Possible values: >= 1

    The number of pages that hold the requested data

  • current_page integer

    Possible values: >= 1

    Current page number

  • filter object

    Available fields

    field namecompare operatorstypevalues
    eventeq, nqstringsee GET /log/items
    categoryeq, nqstringaccess, emergency, system, info
    priorityeq, nqstringlow, medium, high, critical
    timestampeq, nq, lt, gt, ge, letimestampin milliseconds
  • available_filtering boolean
  • is_filtered boolean
  • available_fields object[]
  • field_name string
  • compare_operators string[]

    Possible values: [eq, gt, lt, nq, ge, le]

  • data_type string

    Possible values: [string, integer, timestamp]

  • options object
    anyOf

  • available_values object[]

    This model provide filter available values

  • sort object

    This model describes available sort options can be used to display logs

  • is_sorted boolean

    Direction of sorting

  • order string

    Possible values: [asc, desc]

  • available_fields string[]

    Possible values: [date]

    Available for sorting fields names

  • locale object

    This model describes available languages can be used to display logs

  • locale string

    Possible values: [en, es, ru, uk]

    Default value: en

  • available_locales string[]

    Possible values: [en, es, ru, uk]

  • list_items object[]
  • timestamp int32

    Unix timestamp date and time

  • category string

    Possible values: [access, emergency, system, info]

  • priority string
  • name object
  • key string

    filter key

  • localized string
  • english string
  • info object

    This model provides detailed information about log event

  • model object

    Represents log event raw data

    anyOf

  • account_type string

    Possible values: [admin]

  • localized string
  • english string

    This filed is presented when you choose locale different from "en"

Loading...