Logo

Report

Get list of device locations

Returns list of device locations

SecurityapiKey
Request
path Parameters
enterprise_id
required
string

A UUID string identifying this enterprise.

query Parameters
limit
integer

Number of results to return per page.

offset
integer

The initial index from which to return the results.

Responses
200

successful operation

401

Authorization information is missing or invalid.

404

Not Found.

500

Internal server error

get/v1/enterprise/{enterprise_id}/report/location/
Request samples 
Response samples 
application/json
{
  • "count": 0,
  • "next": "string",
  • "previous": "string",
  • "results": [
    ]
}
Get location of specific device
Returns location information of device


SecurityapiKey 
Request 
path Parameters
enterprise_id
required
string
A UUID string identifying this enterprise.


 
location_id
required
integer
An integer identifying the location.


 
Responses 
200
successful operation


401
Authorization information is missing or invalid.


404
Not Found.


500
Internal server error


get/v1/enterprise/{enterprise_id}/report/location/{location_id}/
Request samples 
Response samples 
application/json
{
  • "id": 0,
  • "latitude": 0,
  • "longitude": 0,
  • "altitude": 0,
  • "city": "string",
  • "status": "string",
  • "country": "string",
  • "zipcode": 0,
  • "last_updated_on": "2019-08-24T14:15:22Z",
  • "device": "string",
  • "enterprise": "string"
}
Get list of device tiles reports
Returns list of device tiles reports


SecurityapiKey 
Request 
path Parameters
enterprise_id
required
string
A UUID string identifying this enterprise.


 
query Parameters
state
integer
Filter device-tile reports by state.


 
created_on_gt
string <datetime> 
Filter device-tile reports created after a given timestamp.


 
created_on_lt
string <datetime> 
Flter device-tile reports created before a given timestamp.


 
provisioned_on_gt
string <datetime> 
Filter device-tile reports provisioned after a given timestamp.


 
provisioned_on_lt
string <datetime> 
Filter device-tile reports provisioned before a given timestamp.


 
updated_on_gt
string <datetime> 
Filter device-tile reports updated after a given timestamp.


 
updated_on_lt
string <datetime> 
Filter device-tile reports updated before a given timestamp.


 
last_seen_gt
string <datetime> 
Filter device-tile reports last seen after a given timestamp.


 
last_seen_lt
string <datetime> 
Filter device-tile reports last seen before a given timestamp.


 
battery_level_gte
number <double> 
Filter device-tile reports by battery level greater than given battery level.


 
battery_level_lte
number <double> 
Filter device-tile reports by battery level lower than given battery level.


 
at_risk
boolean
Filter device-tile reports by whether they are at risk.


 
security_status
integer <int32>  (SecurityStatesEnum) 
Following are the Security States and their description


  * 1 = SECURE
  * 10 = LOW_RISK
  * 20 = MEDIUM_RISK
  * 30 = HIGH_RISK
  * 100 = DEVICE_STATE_UNSPECIFIED



 Enum: 1 10 20 30 100  
status
string
Filter device-tile reports by status.


 
group
string <uuid> 
Filter device-tile reports by group.


 
group_name
string
Filter device-tile reports by group name.


 
group_name_multi
string
Filter device-tile reports using multiple group names.


 
group_multi
string <uuid> 
Filter device-tile reports by using multiple group ID's


 
group_multi_immediate
string
Filter device-tile reports by immediate groups


 
group_null
string <boolean> 
Filter device-tile reports by availability of group. True returns device-tiles with no group. False returns device-tiles with group.


 
imei
string
Filter device-tile reports by imei.


 
name
string
Filter device-tile reports by device name.


 
recently_added
boolean
Filter device-tile reports by recently added.


 
is_gms
boolean
Filter device-tile reports for gms devices.


 
tags
string
Filter device-tile reports by tag.


 
is_geofence_applied
boolean
Filter device-tile reports by geofence application.


 
serial
string
Filter device-tile reports by device serial id.


 
android_version
integer
Filter device-tile reports by android version.


 
android_version_multi
integer
Filter device-tile reports by multiple android versions.


 
wifi_ssid
string
Filter device-tile reports by wifi-ssid.


 
network_type
string
Filter device-tile reports by network type.


 
network_type_multi
string
Filter device-tile reports by multiple network types.


 
model
string
Filter device-tile reports by device model.


 
template
string
Filter device-tile reports by template.


 
template_multi
string
Filter device-tile reports by multiple templates.


 
policy
string
Filter device-tile reports by policy name.


 
policy_multi
string
Filter device-tile reports by multiple policies.


 
policy_null
boolean
Filter device-tile reports by null-value policy.


 
dpc_version
string
Filter device-tile reports by DPC version.


 
location
string
Filter device-tile reports by location.


 
active_connection
boolean
Filter device-tile reports by active connection status.


 
device_type
string
Filter device-tile reports by device type.


 
Responses 
200
successful operation


401
Authorization information is missing or invalid.


404
Not Found.


500
Internal server error


get/v1/enterprise/{enterprise_id}/report/device-tiles/
Request samples 
Response samples 
application/json
{
  • "count": 0,
  • "next": "string",
  • "previous": "string",
  • "results": [
    ]
}
Get instance of device tiles report
Returns instance of device tiles report


SecurityapiKey 
Request 
path Parameters
enterprise_id
required
string
A UUID string identifying this enterprise.


 
device_tiles_id
required
integer
An integer representing the device tile report.


 
Responses 
200
successful operation


401
Authorization information is missing or invalid.


404
Not Found.


500
Internal server error


get/v1/enterprise/{enterprise_id}/report/device-tiles/{device_tiles_id}
Request samples 
Response samples 
application/json
{
  • "id": 0,
  • "device": {
    },
  • "network_info": {
    },
  • "model": "string",
  • "location": { },
  • "battery_level": 0,
  • "security_state": "string",
  • "security_reason": "string",
  • "security_advise": "string",
  • "wifi_ssid": "string",
  • "updated_on": "2019-08-24T14:15:22Z",
  • "created_on": "2019-08-24T14:15:22Z",
  • "is_active": true,
  • "is_gms": true,
  • "status_id": 0,
  • "serial_no": "string",
  • "android_version": 0,
  • "eea_version": "string",
  • "dpc_version": "string",
  • "location_city": "string",
  • "network_type": "string",
  • "enterprise": "string",
  • "icon": "string"
}
Get status metrics report for enterprise
Returns status metrics report for enterprise


SecurityapiKey 
Request 
path Parameters
enterprise_id
required
string
A UUID string identifying this enterprise.


 
Responses 
200
successful operation


401
Authorization information is missing or invalid.


404
Not Found.


500
Internal server error


get/v1/enterprise/{enterprise_id}/report/status-metrics/
Request samples 
Response samples 
application/json
{
  • "active": 0,
  • "in_active": 0,
  • "low_risk": 0,
  • "high_risk": 0,
  • "medium_risk": 0,
  • "secure": 0,
  • "low_battery": 0,
  • "under_provisioning": 0,
  • "recently_added": 0,
  • "unspecified": 0,
  • "total_devices_under_risk": 0
}
Get report information
Returns report information


SecurityapiKey 
Responses 
200
successful operation


401
Authorization information is missing or invalid.


404
Not Found.


500
Internal server error


get/enterprise/report/info/
Request samples 
Response samples 
application/json
{
  • "reportAvailabilityFrom": "2019-08-24T14:15:22Z",
  • "enableReportsWorkflow": true
}
Get device status reports within specified date-time range
Returns device status reports within specified date-time range


SecurityapiKey 
Request 
query Parameters
start_date
required
string <date-time> 
Start date of range in which to retrieve device status reports


 
end_date
required
string <date-time> 
End date of range in which to retrieve device status reports


 
sync
boolean
Sync device status report to specified field


 
fields
string
List of fields to add to device status report, comma separated


 
Responses 
200
successful operation


401
Authorization information is missing or invalid.


404
Not Found.


500
Internal server error


get/enterprise/report/device-report/
Request samples 
Response samples 
application/json
[
  • {
    }
]
Get enterprise report
Returns enterprise report of devices within specified date-time range


SecurityapiKey 
Request 
query Parameters
start_date
required
string <date-time> 
Start date of range in which to retrieve enterprise report.


 
end_date
required
string <date-time> 
End date of range in which to retrieve enterprise report.


 
Responses 
200
successful operation


401
Authorization information is missing or invalid.


404
Not Found.


500
Internal server error


get/enterprise/report/enterprise-report/
Request samples 
Response samples 
application/json
{
  • "peak_active_devices": 0,
  • "provisioned_devices": 0,
  • "registered_devices": 0
}
Get group report
Returns group report of devices within specified date-time range


SecurityapiKey 
Request 
query Parameters
start_date
required
string <date-time> 
Start date of range in which to retrieve group report.


 
end_date
required
string <date-time> 
End date of range in which to retrieve group report.


 
Responses 
200
successful operation


401
Authorization information is missing or invalid.


404
Not Found.


500
Internal server error


get/enterprise/report/group-report/
Request samples 
Response samples 
application/json
[
  • {
    }
]
Get list of subscription reports
Returns list of subscription reports


SecurityapiKey 
Responses 
200
successful operation


401
Authorization information is missing or invalid.


404
Not Found.


500
Internal server error


get/enterprise/report/subscription/
Request samples 
Response samples 
application/json
{
  • "count": 0,
  • "next": "string",
  • "previous": "string",
  • "results": [
    ]
}
Post subscription to enterprise
Returns instance of created subscription


SecurityapiKey 
Request 
Request Body schema: application/json
required
email_ids
required
Array of strings <email> 
 
Responses 
201
Successful Operation


400
Bad request


401
Authorization information is missing or invalid.


403
Forbidden, no permission to perform this action.


500
Internal server error


post/enterprise/report/subscription/
Request samples 
application/json
{
  • "email_ids": [
    ]
}
Response samples 
application/json
{
  • "id": 0,
  • "email_ids": [
    ],
  • "is_subscribed": true,
  • "created_on": "2019-08-24T14:15:22Z",
  • "updated_on": "2019-08-24T14:15:22Z"
}
Get instance of subscription
Returns instance of subscription


SecurityapiKey 
Request 
path Parameters
subscription_id
required
integer
A integer value identifying the subscription


 
Responses 
200
successful operation


401
Authorization information is missing or invalid.


404
Not Found.


500
Internal server error


get/enterprise/report/subscription/{subscription_id}/
Request samples 
Response samples 
application/json
{
  • "id": 0,
  • "email_ids": [
    ],
  • "is_subscribed": true,
  • "created_on": "2019-08-24T14:15:22Z",
  • "updated_on": "2019-08-24T14:15:22Z"
}
Update subscription
Returns instance of updated subscription


SecurityapiKey 
Request 
path Parameters
subscription_id
required
integer
A integer value identifying the subscription.


 
Request Body schema: application/json
required
email_ids
required
Array of strings <email> 
 
is_subscribed
boolean
 
Responses 
200
successful operation


400
Invalid request.


401
Authorization information is missing or invalid.


404
Not Found.


500
Internal server error


put/enterprise/report/subscription/{subscription_id}/
Request samples 
application/json
{
  • "email_ids": [
    ],
  • "is_subscribed": true
}
Response samples 
application/json
{
  • "id": 0,
  • "email_ids": [
    ],
  • "is_subscribed": true,
  • "created_on": "2019-08-24T14:15:22Z",
  • "updated_on": "2019-08-24T14:15:22Z"
}
Partially update subscription
Returns instance of updated subscription


SecurityapiKey 
Request 
path Parameters
subscription_id
required
integer
A integer value identifying the subscription.


 
Request Body schema: application/json
email_ids
Array of strings <email> 
 
is_subscribed
boolean
 
Responses 
200
successful operation


400
Invalid request.


401
Authorization information is missing or invalid.


404
Not Found.


500
Internal server error


patch/enterprise/report/subscription/{subscription_id}/
Request samples 
application/json
{
  • "email_ids": [
    ],
  • "is_subscribed": true
}
Response samples 
application/json
{
  • "id": 0,
  • "email_ids": [
    ],
  • "is_subscribed": true,
  • "created_on": "2019-08-24T14:15:22Z",
  • "updated_on": "2019-08-24T14:15:22Z"
}
Deletes instance of subscription
Empty response


SecurityapiKey 
Request 
path Parameters
subscription_id
required
integer
A integer value identifying the subscription.


 
Responses 
204
The resource was deleted successfully.


400
Invalid request.


401
Authorization information is missing or invalid.


403
Forbidden, no permission to perform this action.


404
Not Found.


500
Internal server error


delete/enterprise/report/subscription/{subscription_id}/
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "message": "string",
  • "status": 0
}
Get status metrics report for enterprise
Returns status metrics report for enterprise


SecurityapiKey 
Request 
path Parameters
enterprise_id
required
string
A UUID string identifying this enterprise.


 
Responses 
200
successful operation


401
Authorization information is missing or invalid.


500
Internal server error


get/v2/enterprise/{enterprise_id}/report/status-metrics/
Request samples 
Response samples 
application/json
{
  • "last_seen": {
    },
  • "low_risk": 0,
  • "high_risk": 0,
  • "medium_risk": 0,
  • "secure": 0,
  • "low_battery": 0,
  • "under_provisioning": 0,
  • "recently_added": 0,
  • "unspecified": 0,
  • "total_devices_under_risk": 0
}
➔ Next to Connections