Device Availability
Remote Manager generates device availability reports that can categorize device connectivity with Remote Manager.
Use the v1/reports API to get a list of all available reports or a specific status report.
URI
http://<hostname>/ws/v1/reports/device_availability
Formats
| Method | Formats | Description | Parameters |
|---|---|---|---|
| GET | /ws/v1/reports/device_availability/details | Get a list of detailed device availability information for devices. | cursor, end_time, orderby, query, size, start_time |
| GET | /ws/v1/reports/device_availability/details/bulk | Get a CSV list of detailed device availability information for devices. | end_time, orderby, query, start_time, fields |
| GET | /ws/v1/reports/device_availability/summary | Get a list of summarized device availability information for devices. | end_time, orderby, query, start_time |
| GET | /ws/v1/reports/device_availability/summary/bulk | Get a CSV list of summarized device availability information for devices. | end_time, orderby, query, start_time, fields |
Parameters
| Name | Type | Description |
|---|---|---|
| cursor | string | Specify the cursor (returned in the last page of results) to resume paging through results. |
| end_time | timestamp | Specify the end time (exclusive) in ISO 8601 or epoch (long) or relative time (matching the form [-+]N[dhms] where d is days, h is hours, m is minutes, s is seconds, and -1d means one day ago, while +1d means one day from now). |
| fields | string | Comma-separated list of fields to return for bulk API |
| orderby | string | Specify the field to order by, optionally followed by asc or desc for ascending or descending sort. In addition to query fields, you can specify uptime_percentage to order by the connected percentage of the target devices. |
| query | string | Specify the device query to summarize. The query language is similar to SQL Query sntax:SQL-like conditions using AND, OR, and parenthesis to group expressionsVarious condition operators on numeric and text valuesSingle quoted text literals: ‘TheText’Text escape for quote character is the quote: ‘isn’’t difficult’Numeric literals support 0x prefix for hexEnumerated values (like connection_status) are treated as textCase insensitive comparisonsTimestamp field conditions are not supported. |
| size | integer | Specify the size of the page to return. |
| start_time | timestamp | Specify the start time (inclusive) in ISO 8601 or epoch (long) or relative time (matching the form [-+]N[dhms] where d is days, h is hours, m is minutes, s is seconds, and -1d means one day ago, while +1d means one day from now). |
Query fields
Build query conditions using the following fields for device availability.
See v1 API Query Language for detailed information on building API queries.
- connection_status - The current ‘connected’ or ‘disconnected’ state of the device
- customer_id - The id of the account owning the device
- device_id - The device ID of the device
- device_type - The type of the device
- group - The current group that the device is stored in
- last_connect - The last connect time of the device
- name - The current name of the device
- vendor_id - The vendor ID of the device