Get logs list

Get logs list. Available events:

Access

• access_denied_by_not_valid_identifier
• access_denied_by_not_valid_input_code
• access_denied_by_remote_server_api_call
• access_denied_by_web_api_call
• access_denied_by_unknown_card
• access_granted_by_valid_identifier
• access_granted_by_master_code
• access_granted_by_api_call
• access_granted_by_call_host
• access_granted_by_remote_server_api_call
• lock_was_opened_by_exit_btn
• access_denied_by_unknown_qr_code
• lock_is_opened_too_long
• door_sensor_was_closed
• door_sensor_was_opened

Info

• outgoing_call
• incoming_call
• lock_is_opened_too_long

System

• successful_login_api_call
• incorrect_login_api_call

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[]

  list of options for getting array of logs

  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

  is_filtered boolean

  is filter applied

  available_fields object[]

  list of fields available to filter by

  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[]

  Possible values: >= 1

  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

  true - has date, false - doesn't

  has_time boolean

  Default value: false

  true - has time, false - doesn't

  has_milliseconds boolean

  Default value: false

  true - has milliseconds, false - doesn't

  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]

  sorting order asc - ascending, desc - 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

  locale for logs

  available_locales string[]

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

  list of available locales for logs

• list_items object[]

  list of logs

  timestamp int64

  Unix Timestamp Date

  category string

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

  to which event category this log is related

  priority string

  priority of event

  name object

  name of event

  key string

  filter key

  localized string

  localized text of log

  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
  • MOD9
  • MOD10
  • MOD11
  • MOD12
  • MOD13
  • MOD14
  • MOD16
  • MOD17
  • MOD18
  • MOD19
  • MOD20

  ---

  account_type string

  Possible values: [admin]

  account role that affects permissions

  account_type string

  Possible values: [admin]

  account role that affects permissions

  number string

  number to call to

  answered boolean

  state of the call, was it answered or not

  number string

  number to call to

  answered boolean

  state of the call, was it answered or not

  info string

  info about event

  info string

  info about event

  number integer

  identifier number

  type string

  identifier type

  owner string

  identifier's owner

  apartment_address string

  apartment address

  lock integer

  lock number

  code string

  input code that was used

  card string

  card that was used

  lock integer

  opened lock's number

  host string

  host that granted the access

  lock integer

  opened lock's number

  lock integer

  opened lock's number

  device_name string

  Possible values: [door_sensor, enter_button]

  name of the device that opnened the door

  number integer

  identifier number

  type string

  identifier type

  owner string

  identifier owner

  apartment_address string

  appartment address

  lock integer

  opened lock's number

  lock_opened_time integer

  In seconds

  account_type string

  Possible values: [admin]

  account role that affects permissions

  account_type string

  Possible values: [admin]

  account role that affects permissions

  number string

  number to call to

  answered boolean

  state of the call, was it answered or not

  localized string

  log translated to chosen language

{
  "list_option": {},
  "list_items": [
    {
      "timestamp": 1540819272,
      "category": "access",
      "priority": "high",
      "name": {
        "key": "access_denied_by_web_api_call",
        "localized": "Access denied by web interface"
      },
      "info": {
        "model": {},
        "localized": "Lock is opened too long"
      }
    }
  ]
}

{
  "list_items": [
    {
      "timestamp": 1630151311060,
      "category": "access",
      "priority": "high",
      "name": {
        "key": "access_denied_by_unknown_card",
        "localized": "Unknown identifier"
      },
      "info": {
        "card": "9893270",
        "type": "access card",
        "apartment_address": "",
        "apartment_name": "",
        "localized": "Unknown identifier 9893270 used"
      }
    }
  ],
  "list_option": {
    "pagination": {
      "total_items": 1,
      "items_limit": 10,
      "total_pages": 1,
      "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_not_valid_input_code",
              "access_denied_by_remote_server_api_call",
              "access_denied_by_unknown_card",
              "access_denied_by_unknown_qr",
              "access_denied_by_web_api_call",
              "access_granted_by_api_call",
              "access_granted_by_call_host",
              "access_granted_by_master_code",
              "access_granted_by_remote_server_api_call",
              "access_granted_by_valid_identifier",
              "door_was_closed",
              "door_was_opened",
              "emergency_cancel",
              "emergency_start",
              "incoming_call",
              "incorrect_login_api_call",
              "lock_is_opened_to_long",
              "lock_was_opened_by_exit_btn",
              "outgoing_call",
              "successful_login_api_call"
            ],
            "available_values_localized": [
              "Not valid identifier",
              "Wrong input code",
              "Access denied by remote server",
              "Unknown identifier",
              "Unknown QR code",
              "Access denied by the web interface",
              "Access granted by the web interface",
              "Lock opened by response device",
              "General access code entered",
              "Access granted by remote server",
              "Lock opened by identifier",
              "Door was closed",
              "Door was opened",
              "Emergency event cancel",
              "Emergency event start",
              "Incoming call",
              "Failed login attempt to the web interface",
              "Lock opened too long",
              "Lock opened by exit button",
              "Outgoing call",
              "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

Log In

Loading...