intelliFlow
Remote Manager generates intelliFlow reports for devices with intelliFlow data collection enabled.
An intelliFlow report categorizes traffic from host systems through end devices to server systems.
The host system is typically a PC or IOT device getting a DHCP address from the end device. The end device is typically a cellular router that connects directly to Remote Manager for statistics and management services. The host system typically communicates via the end device to many servers for email, web browsing or other network services via TCP/IP.
On a DAL (Digi Accelerated Linux) device, the intelliFlow data reporting must be enabled using Monitoring -> intelliFlow -> Enable intelliFlow setting.
Use the v1/reports API to get a list of all available reports or a specific status report.
URI
http://<hostname>/ws/v1/reports/intelliflow
Formats
| Method | Formats | Description | Parameters |
|---|---|---|---|
| GET | /ws/v1/reports/intelliflow/detail | Get a list of detailed intelliFlow information for devices. | cursor, end_time, orderby, query, report_type, size, start_time |
| GET | /ws/v1/reports/intelliflow/detail/bulk | Get a CSV list of detailed intelliFlow information for devices. | end_time, orderby, query, report_type, start_time, fields |
| GET | /ws/v1/reports/intelliflow/summary | Get a list of summarized intelliFlow information for devices. | end_time, orderby, query, report_type, start_time |
| GET | /ws/v1/reports/intelliflow/summary/bulk | Get a CSV list of summarized intelliFlow information for devices. | end_time, orderby, query, report_type, 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. |
| 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. |
| report_type | string | Specify the report type to categorize data. Both detail and summary information is additionally categorized by report_type. |
| 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). |
Report Type Values
The intelliFlow report type categorizes device traffic by the specified field.
| Value | Description |
|---|---|
| port | Categorize by port number. |
| port_name | Categorize by port name. These are the IANA names. |
| service_type | Categorize by service type. These names are configured in the intelliFlow settings on the device. |
| server_address | Categorize by the server address. |
| server_domain | Categorize by the server domain name. |
| host_address | Categorize by the host that is communicating via the end device. |
Query fields
Build query conditions using the following fields for intelliFlow.
See v1 API Query Language for detailed information on building API queries.
- bytes_received - The number of bytes sent in the interval
- bytes_sent - The number of bytes sent in the interval
- customer_id - The id of the account owning the device
- device_id - The device ID of the end device that recorded the traffic
- device_type - The type of the end device
- firmware_version - The current firmware version of the end device
- group - The current group that the end device is stored in
- host_address - The IP address of the host communicating via the end device
- host_mac - The Mac address of the host communicating via the end device
- host_name - The name of the host communicating via the end device
- hour - The timestamp representing the hour that the data was recorded
- name - The current name of the end device
- port - The port number destination of the traffic
- port_name - The IANA name of the traffic
- server_address - The server address of the traffic
- server_domain - The domain name of the server of the traffic
- service_type - The service name configured for the port in the intelliFlow settings on the end device