v1/reports

Remote Manager generates many different types of reports including information on alarms, device properties, connections, health, and monitors. Use the v1/reports API to get a list of all available reports or a specific status report.

URI

http://<hostname>/ws/v1/reports

Report Categories

Some report APIs constitute a larger group of APIs that use common parameters and query fields or control reporting more generally.

• Cellular Utilization
• Device Availability
• intelliFlow
• Report Scheduling

Individual Reports

The following individual report APIs are similar in parameters and query fields.

Parameters

Query fields

• carrier/carrier2 - the current network carrier of the primary or secondary cellular service
• connection_status - one of ‘connected’ or ‘disconnected’
• contact - any user contact information
• description - any description associated with the device
• firmware_version - the firmware level
• health_status - one of ’normal’, ‘warning’, ’error’ or ‘unknown’
• id - the device ID
• ip - the last known IP address of the device
• last_connect - last connect time of the device
• last_disconnect - last disconnect time of the device
• last_disconnect_reason - the reason for the last disconnect
• last_update - last update time of the device
• location - the device location
• mac - the MAC address
• name - the device name
• network/network2 - the current network (for example LTE) of the primary or secondary cellular service
• notes - device notes, also sometimes referred to as user meta data)
• provider/provider2 - the current SIM provider of the primary or secondary cellular service
• public_ip - the last known global IP address of the device
• restricted_status - one of ‘unrestricted’, ‘restricted’, ‘disabled’, ‘untrusted’
• serial_number - the device serial number
• signal_percent/signal_percent2 - the percent of signal strength from 0 to 100 primary or secondary cellular service
• signal_quality/signal_quality2 - the signal quality of the primary or secondary cellular service
• signal_strength/signal_strength2 - the signal strength of the primary or secondary cellular service
• type - the device type
• vendor_id - the vendor ID value of the device

Query operators

• =, <>-Equality comparisons, used on any numeric, group, tag, text or enumerated fields
• <, <=, >, >=-Relative comparisons, used on any numeric or text fields. Not used for group, tag or enumerated fields
• startsWith, endsWith, contains-Used on any group, tag or text matching fields. Not used for numeric fields

Timestamp field comparisons are not supported.

Query examples

• Complex queries

query=group startsWith '/NorthWest' and (connection_status = 'disconnected' or signal_percent < 20)

Find any devices in the /Northwest group and any subgroups that are either disconnected or have a low signal strength.

query=tags = 'important' and (health_status = 'error' or health_status = 'warning')

Find any devices that have the ‘important’ tag and are in an error or warning health status.

• Group queries

query=group = '/test'

Query full group path, so matches any device in group ‘/test’ and ignores any subgroups.

query=group startsWith 'test/'

Query full group path, so matches any device in the test root group and any subgroups.

query=group startsWith 'test'

Query full group path, so matches any device in any root group whose name starts with ’test’ and all subgroups.

query=group endsWith '/leaf'

Query full group path, so matches any device in any path that ends with the group name ’leaf’.

• Tag Queries

query=tags = 'sensor'

Matches any device having a tag ‘sensor’.

query=tags <> 'sensor'

Matches any device having no tag ‘sensor’.

query=tags contains 'ns'

Matches any device having any tag containing ’ns’.

query=tags startsWith 'sens'

Matches any device having any tag that starts with ‘sens’.

query=tags endsWith 'or'

Matches any device having any tag that ends with ‘or’.