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 name	see the list of available fields in filter.available_fields[].field_name
  value	see the list of available values in filter.available_fields[].options object, may be missing
  compare operator	see the list of available operators in filter.available_fields[].compare_operators array

  Compare operators	Description	Example
  eq	Equal	name eq 'Sherlock Holmes'
  gt	Greater than	building gt 10
  lt	Less than	building lt 10
  nq	Not equal	name nq 'Sherlock Holmes'
  ge	Greater than or equal	floor ge 5
  le	Less than or equal	floor le 5
  Logical operators
  and	logical AND	floor le 10 and floor gt 3
  or	logical OR	floor le 3 or floor gt 10
  not	logical NOT	not floor le 3
  group operations
  ()	group by priority	(name eq 'Sherlock Holmes' or building eq 221) and floor gt 10

Responses

• 200
• 400
• 401

---

OK

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• list_option object[]

  array with options

  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 name	compare operators	type	values
  event	eq, nq	string	see GET /log/items
  category	eq, nq	string	access, emergency, system, info
  priority	eq, nq	string	low, medium, high, critical
  timestamp	eq, nq, lt, gt, ge, le	timestamp	in milliseconds

  available_filtering boolean

  is filtering available for this list

  is_filtered boolean

  is this list currently filtered

  available_fields object[]

  available fields for filtering

  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

  • MOD1
  • MOD2
  • MOD3
  • MOD4

  ---

  available_values object[]

  This model provide filter available values

  available_range integer[]

  Possible values: >= 2, <= 2

  This model provide filter integer range

  available_values_localized string[]

  the field is used only for UI localization and is not a filter value.

  has_date boolean

  Default value: false

  filtering by date

  has_time boolean

  Default value: false

  filtering by time

  has_milliseconds boolean

  Default value: false

  filtering by timestamp

  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]

  order in which will be sorted, ascending or descending

  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

  current device's locale

  available_locales string[]

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

  all available locales on device

• list_items object[]

  array with resulting items

  timestamp int32

  Unix timestamp date and time

  category string

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

  category to which log is related

  priority string

  log priority so user can pay attention to more critical ones

  name object

  log event name

  key string

  filter key

  localized string

  string with translated info

  english string

  string with info in english

  info object

  This model provides detailed information about log event

  model object

  Represents log event raw data

  anyOf

  • MOD2
  • MOD3
  • MOD4
  • MOD5
  • MOD6
  • MOD7
  • MOD8

  ---

  account_type string

  Possible values: [admin]

  type of account used for login

  account_type string

  Possible values: [admin]

  type of account used for login

  number string

  identifier number

  type string

  Possible values: [card, ukey, input_code, qr, face_id]

  This model describes the types of identifiers

  floors string[]

  Possible values: non-empty and <= 64 characters

  List of floors to which access has been granted

  apartments string[]

  Possible values: Value must match regular expression ^\d{2}-\d{2}$

  List of apartments to which access has been granted

  number string

  identifier number

  type string

  Possible values: [card, ukey, input_code, qr, face_id]

  This model describes the types of identifiers

  number string

  identifier number

  type string

  Possible values: [card, ukey, input_code, qr, face_id]

  This model describes the types of identifiers

  caller string

  Possible values: [api, remote_server, broadcast_message, concierge, broadcast_panel, broadcast_monitor]

  This model describes the entity that call the lift, affects the display in the device log

  floors string[]

  List of floors to which access has been granted

  apartments string[]

  List of apartments to which access has been granted

  caller string

  Possible values: [api, remote_server, broadcast_message, concierge, broadcast_panel, broadcast_monitor]

  This model describes the entity that call the lift, affects the display in the device log

  name string

  Possible values: non-empty and <= 64 characters

  floor name 64 UTF-8 chars

  number integer

  Possible values: <= 98

  floor number

  localized string

  translated version

  english string

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

{
  "list_option": [
    {
      "pagination": {
        "total_items": 18,
        "items_limit": 10,
        "total_pages": 2,
        "current_page": 1
      },
      "filter": {
        "available_filtering": true,
        "is_filtered": false,
        "available_fields": [
          {
            "field_name": "category",
            "compare_operators": [
              "eq"
            ],
            "data_type": "string",
            "options": {
              "available_values": [
                "string",
                0
              ]
            }
          }
        ]
      },
      "sort": {
        "is_sorted": true,
        "order": "asc",
        "available_fields": [
          "date"
        ]
      },
      "locale": {
        "locale": "en",
        "available_locales": [
          "en",
          "es",
          "ru",
          "uk"
        ]
      }
    }
  ],
  "list_items": [
    {
      "timestamp": 1540819272,
      "category": "access",
      "priority": "high",
      "name": {
        "key": "access_denied_by_web_api_call",
        "localized": "Access denied by web interface",
        "english": "Access denied by web interface"
      },
      "info": {
        "model": {},
        "localized": "Acceso denegado por identificador desconocido",
        "english": "Access denied by unknown identifier"
      }
    }
  ]
}

{
  "list_items": [
    {
      "timestamp": 16494219,
      "category": "system",
      "priority": "low",
      "name": {
        "key": "successful_login_api_call",
        "localized": "Login to the web interface",
        "english": "Login to the web interface"
      },
      "info": {
        "account_type": "admin",
        "english": "Successful (admin) login to the web interface",
        "localized": "Successful (admin) login to the web interface"
      }
    }
  ],
  "list_option": [
    {
      "pagination": {
        "total_items": 264,
        "items_limit": 10,
        "total_pages": 264,
        "current_page": 1
      },
      "sort": {
        "is_sorted": true,
        "order": "desc",
        "available_fields": [
          "date"
        ]
      },
      "filter": {
        "is_filtered": false,
        "available_filtering": true,
        "available_fields": [
          {
            "field_name": "category",
            "compare_operators": [
              "eq",
              "nq"
            ],
            "data_type": "string",
            "options": {
              "available_values": [
                "access",
                "emergency",
                "system",
                "info"
              ]
            }
          },
          {
            "field_name": "event",
            "compare_operators": [
              "eq",
              "nq"
            ],
            "data_type": "string",
            "options": {
              "available_values": [
                "access_denied_by_not_valid_identifier",
                "access_denied_by_unknown_identifier",
                "access_granted_by_api_call",
                "access_granted_by_valid_identifier",
                "incorrect_login_api_call",
                "lift_called_to_floor",
                "successful_login_api_call"
              ],
              "available_values_localized": [
                "Not valid identifier",
                "Unknown identifier",
                "Access granted by API call",
                "Valid identifier used",
                "Failed login attempt to the web interface",
                "Elevator called to the floor",
                "Login to the web interface"
              ]
            }
          },
          {
            "field_name": "priority",
            "compare_operators": [
              "eq",
              "nq"
            ],
            "data_type": "string",
            "options": {
              "available_values": [
                "low",
                "medium",
                "high",
                "critical"
              ]
            }
          },
          {
            "field_name": "timestamp",
            "compare_operators": [
              "eq",
              "nq",
              "lt",
              "gt",
              "ge",
              "le"
            ],
            "data_type": "timestamp",
            "options": {
              "has_milliseconds": true,
              "has_date": true,
              "has_time": true
            }
          }
        ]
      }
    }
  ]
}

• Bad request.
• Pagination: wrong limit
• Pagination: wrong page
• Wrong time format
• Wrong time range: 'to' must be greater then 'from'
• Filter: wrong filter_type
• Filter: wrong filter_field
• Filter: wrong filter_value
• Sort: wrong sort_type
• Wrong number format

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• error object

  object containing info about error

  code string

  Possible values: [invalid_authentication, permission_denied, not_valid, system_error]

  Error code

  message string

  Error message

  data object

  Did not pass validation parameters. Can be represented as an object, which can include field names, arrays, query parameters etc.

  param string

  extended info on error

{
  "error": {
    "code": "not_valid",
    "message": "Data validation error",
    "data": {
      "param": "must be an string"
    }
  }
}

{
  "error": {
    "code": "not_valid",
    "message": "Data validation error",
    "data": {
      "order_by": [
        "not valid"
      ]
    }
  }
}

Please log in

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• error object

  object containing info about error

  code string

  Possible values: [invalid_authentication, permission_denied, not_valid, system_error]

  Error code

  message string

  Error message

  data object

  Did not pass validation parameters. Can be represented as an object, which can include field names, arrays, query parameters etc.

  param string

  extended info on error

{
  "error": {
    "code": "not_valid",
    "message": "Data validation error",
    "data": {
      "param": "must be an string"
    }
  }
}

{
  "error": {
    "code": "invalid_authentication",
    "message": "Log In"
  }
}

Loading...