Get logs list

Return log's list. Available events:

Query Parameters

locale string
Possible values: [en, ru, uk, es, pl]
Language for localizing logs. Value by default is 'en'
limit integer required
Possible values: <= 1000
Number of items. Value by default is 10
page_number integer required
Possible values: >= 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)

Schema

options object
The model provides options can be used to sort, filter, and paginate log items
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: <= 1000
Limiting the display of the amount of data for one page
total_pages integer
The number of pages that hold the requested data
current_page integer
Possible values: >= 1
Current page number
filter object
Specified filtering options for the requested dataset
available_filtering boolean
Determines if filtering is available for this dataset
is_filtered boolean
Describes if this dataset is filtered
available_fields object[]
List of fields available for filtering
field_name string
Name of the field used for filtering
compare_operators string[]
Possible values: [eq, gt, lt, nq, ge, le, lk]
Set of filter operators available for this field
data_type string
Possible values: [string, integer, timestamp]
Describes data type of the field
options object
Extra settings of the field
anyOf
MOD1
MOD2
MOD3
MOD4
available_values object[]
This model provide filter available values, data type of values depends on field data type
sort object
Describes current sorting information and list of the dataset fields available for sorting
is_sorted boolean
Direction of sorting
order string
Possible values: [asc, desc]
Direction of applied sorting, true is ascending, false is descending
available_fields string[]
List of the dataset fields available for sorting
locale object
This model describes available languages can be used to display logs
locale string
Possible values: [en, es, ru, uk, pl]
Default value: en
Active localization
available_locales string[]
Possible values: [en, es, ru, uk, pl]
List of localization available
items object[]
Log events dataset
timestamp int64
Unix Timestamp Date
category string
Possible values: [access, emergency, system, info]
Event category code
priority string
Possible values: [low, medium, high, critical]
Event priority code
name object
Event name information
key string
The code of the event
text string
Localized name of the event
info object
This model provides detailed information about log event
model object
Represents log event raw data
oneOf
MOD2
MOD3
MOD4
MOD5
MOD6
MOD7
MOD8
MOD9
MOD10
MOD11
MOD12
MOD13
MOD15
MOD18
MOD19
apartment object
Attached apartment or empty
name string
Possible values: <= 100 characters
Name for the apartment, owner full name or apartment number usually used. Nonempty string.
building integer
Possible values: >= 1 and <= 9999
Building number
unit integer
Possible values: <= 99
Unit number
floor integer
Possible values: <= 98
Floor number
room integer
Possible values: <= 99
Room number
user string
Possible values: <= 100 characters
Attached user name or empty
relays_switched integer[]
Switched relays list
number string
Possible values: <= 256 characters

hex if identifier type is card or ukey - max length is 32 bytes

binary if identifier type is card or ukey - min length is 16 symbols, max length is 256 symbols

dec if identifier type is input_сode - max length is 10 symbols

string if identifier type is license_plate - max length is 100 symbols

pattern for hex ([0-9A-Fa-f]{2}[:-]){1,31}([0-9A-Fa-f]{2})

pattern for dec - [0-9]{1,10}

pattern for bin - [01]{16,256}

type string
Possible values: [card, ukey, input_code, license_plate]
Identifier type used for access
name string
Possible values: <= 100 characters
Name of the identifier
reader_id string
Reader unique name, format:
reader_name string
Human readable reader name
text string
Human-readable information about event

{
  "options": {
    "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": [
              "extra option",
              1,
              false
            ]
          }
        }
      ]
    },
    "sort": {
      "is_sorted": true,
      "order": "asc",
      "available_fields": [
        "name"
      ]
    },
    "locale": {
      "locale": "en",
      "available_locales": [
        "uk"
      ]
    }
  },
  "items": [
    {
      "timestamp": 1540819272,
      "category": "access",
      "priority": "high",
      "name": {
        "key": "incoming_call",
        "text": "Access denied by web interface"
      },
      "info": {
        "model": {},
        "text": "Relay 1 switched by API call"
      }
    }
  ]
}

Bad Request

application/json

Schema
Example (from schema)
Example

Schema

error object
Error object, contains error details
code string
Possible values: [invalid_authentication, permission_denied, not_valid, system_error, bad_request, connection_timeout]
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
Contains validation error details

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

{
  "error": {
    "code": "bad_request",
    "message": "Bad request sent"
  }
}

Unauthorized request. Log In

application/json

Schema
Example (from schema)
Example

Schema

error object
Error object, contains error details
code string
Possible values: [invalid_authentication, permission_denied, not_valid, system_error, bad_request, connection_timeout]
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
Contains validation error details

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

{
  "error": {
    "code": "invalid_authentication",
    "message": "Invalid authentication"
  }
}

Get logs list​

sorting expression:

Filtering expression:

Get logs list