Log's list
Return log's list
Access
access_denied_by_not_valid_identifier
access_denied_by_not_valid_face_identifier
access_denied_by_not_valid_input_code
access_denied_by_remote_server_api_call
access_denied_by_unknown_card
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
access_granted_by_valid_face_identifier
lock_is_opened_to_long
lock_was_opened_by_exit_btn
lock_was_opened_by_free_access_button
Emergency
abnormal_event
emergent_event
Info
incoming_call
outgoing_call
System
firmware_update
Currently not logged
incorrect_login_api_call
successful_login_api_call
device_booted
sip_registration_lost
Query Parameters
- locale string
Possible values: [
en
,es
,ru
,uk
,pl
]Language for localizing logs. Value by default is 'en'
- from integer
Unix time
- to integer
Unix time
- limit integer
Possible values: [
10
,20
,30
,50
]Number of items. Value by default is 10
- page_number integer
Possible values:
>= 1
Page number
- sort_type string
Possible values: [
asc
,desc
]Default value:
asc
Sort type (asc/desc)
- filter object
Filtering options
- 200
- 400
- 401
OK
- application/json
- Schema
- Example (from schema)
Schema
list_option object[]
locale object
locale stringPossible values: [
en
,es
,ru
,uk
,pl
]available_locales string[]filter object
available_filtering booleanis_filtered booleanavailable_fields object[]available_values object
category string[]priority string[]name object[]
key stringPossible values: [
access_denied_by_not_valid_identifier
,access_denied_by_not_valid_face_identifier
,access_denied_by_not_valid_input_code
,access_denied_by_remote_server_api_call
,access_denied_by_unknown_card
,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
,access_granted_by_valid_face_identifier
,lock_is_opened_to_long
,lock_was_opened_by_exit_btn
,lock_was_opened_by_free_access_button
,abnormal_event
,emergent_event
,incoming_call
,movement_detected
,outgoing_call
,firmware_update
,incorrect_login_api_call
,successful_login_api_call
,device_restarted
,sip_registration_lost
]this key should be used for filtering options
localized stringenglish stringsort object
asc booleanDefault value:
true
available_sorting string[]list_items object[]
timestamp int64Unix Timestamp Date
category stringPossible values: [
access
,emergency
,system
,info
]priority stringname object
key stringfilter key
localized stringenglish stringinfo object
model object
oneOf- MOD1
- MOD2
- MOD3
- MOD4
- MOD5
- MOD6
- MOD7
- MOD8
- MOD9
- MOD10
- MOD11
- MOD12
- MOD13
- MOD14
- MOD15
- MOD17
- MOD18
- MOD19
- MOD20
- MOD21
status stringPossible values: [
checking
,downloading
,backuping
,installing
,finishing
,error
]account_type stringPossible values: [
admin
,manager
]account_type stringPossible values: [
admin
,manager
]number stringanswered booleannumber stringanswered booleaninfo stringinfo stringnumber integertype stringowner stringapartment_address stringlock integernumber integertype stringowner stringapartment_address stringlock integercode stringcard stringlock integerhost stringlock integerlock integerdevice_name stringPossible values: [
door_sensor
,enter_button
]number integertype stringowner stringapartment_address stringlock integernumber integertype stringowner stringapartment_address stringlock integerlock_opened_time integerIn seconds
account_type stringPossible values: [
admin
,manager
]account_type stringPossible values: [
admin
,manager
]localized stringenglish stringThis filed is presented when you choose locale different from "en"
{
"list_option": [
{
"locale": {
"locale": "en",
"available_locales": [
[
"en",
"es",
"ru",
"uk",
"pl"
]
]
},
"filter": {
"available_filtering": true,
"is_filtered": true,
"available_fields": [
{
"filter_field": "priority",
"available_types": [
[
"more",
"less",
"equal"
]
]
},
{
"filter_field": "category",
"available_types": [
[
"equal"
]
]
},
{
"filter_field": "name",
"available_types": [
[
"equal"
]
]
}
],
"available_values": {
"category": [
[
"access",
"emergency",
"system",
"info"
]
],
"priority": [
[
"critical",
"high",
"low",
"medium"
]
],
"name": [
{
"key": "access_denied_by_not_valid_input_code",
"localized": "Wrong input code",
"english": "Wrong input code"
}
]
}
},
"sort": {
"asc": true,
"available_sorting": [
[
"asc",
"desc"
]
]
}
}
],
"list_items": [
{
"timestamp": 1540819272,
"category": "access",
"priority": "high",
"name": {
"key": "incoming_call",
"localized": "Access denied by web interface",
"english": "Access denied by web interface"
},
"info": {
"model": {
"status": "checking"
},
"localized": "string",
"english": "string"
}
}
]
}
- 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