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

application/json

Schema
Example (from schema)
Example

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 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_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

MOD1
MOD2
MOD3
MOD4

available_values string,integer[]

Possible values: >= 1

This model provide filter available values

available_range integer[]

Possible values: >= 2, <= 2

This model provide filter integer range

has_date boolean

Default value: false

has_time boolean

Default value: false

has_milliseconds boolean

Default value: false

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 int64
Unix Timestamp Date
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
MOD2
MOD3
MOD4
MOD5
MOD6
MOD7
MOD8
MOD9
MOD10
MOD11
MOD12
MOD13
MOD14
MOD16
MOD17
MOD18
MOD19
MOD20
account_type string
Possible values: [admin]
localized string
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": true,
        "available_fields": [
          {
            "field_name": "category",
            "compare_operators": [
              "eq"
            ],
            "data_type": "string",
            "options": {
              "available_values": [
                "any string"
              ]
            }
          }
        ]
      },
      "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": "string",
        "english": "string"
      }
    }
  ]
}

{
  "list_items": [
    {
      "timestamp": 1630151311060,
      "category": "access",
      "priority": "high",
      "name": {
        "key": "access_denied_by_unknown_card",
        "localized": "Unknown identifier",
        "english": "Unknown identifier"
      },
      "info": {
        "card": "9893270",
        "type": "access card",
        "apartment_address": "",
        "apartment_name": "",
        "english": "Unknown identifier 9893270 used",
        "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
          }
        }
      ]
    }
  }
}

Get logs list​

Access​

Info​

System​

sorting expression:

Filtering expression:

Available fields​

Get logs list

Access

Info

System

Available fields