Analytics data feed

The Analytics data feed policy allows you to retrieve data for a large number of devices, without having to directly call the Knox Guard server using the Knox Guard API. This allows you to consistently receive large amounts of data, without having to worry about timeouts or system stability.

While you must have Knox Guard Edition devices to use this feature, analytics data is available for all devices in your tenant.

Prerequisites

To use this feature, you must have:

• Knox Guard Edition devices.
• Access to the Knox API Portal. You can apply for access to the Knox API service by contacting your Samsung representative, or by creating a support ticket.
• For sub admins, the appropriate role permissions:
  • Analytics Data Feed
  • Allow access to Knox Cloud APIs portal

How to retrieve data using the Analytics data feed

Setting up your analytics data feed requires a few key steps:

1. Generate your Knox Guard client identifier and key pair.
2. Configure your analytics data feed settings on the Knox Guard console.
3. Generate your SFTP access token.
4. Retrieve data using an SFTP call.
5. Decrypt the downloaded files.

Generate your Knox Guard client identifier and key pair

Knox Guard uses Knox Cloud Authentication, our legacy authentication scheme. Before you can retrieve or decrypt analytics data, you’ll need to generate your client identifier and key pair from the Knox API Portal. This is the same method you use to generate your REST API key for the Knox Guard API, with a few small differences.

For more information on how to generate these values, see the Knox Guard developer guide.

Configure your Analytics data feed settings

Next, define the data you’d like to retrieve by configuring your data feed settings on the Knox Guard console:

1. Navigate to the Policies page.

2. Under KNOX GUARD EDITION, click ANALYTICS DATA FEED. The Analytics data feed page opens.

3. Enter a Configuration name.

4. Review the Data collection frequency field. Data is available every 12 hours, and reports are ready for download at UTC 00:00 and 12:00.

   Your first report is ready for download at UTC 00:00 or 12:00, 24 hours after you enable this policy.

5. In the IP range allowlist field, enter the IP address or a range of IP addresses where you’ll download the data from. IPv4 addresses and CIDR ranges are accepted.

6. Select a Public key to encrypt the configuration file with. This is the public key you previously generated in step 1.

7. Review the Data category field. You can only receive device list data.

8. Click SAVE.

Once you save your configuration, a success notification containing SFTP Server IP and SFTP Port information displays on the Knox Guard console. Save this — you’ll need these details to connect to the SFTP server later.

It’ll take roughly 24 hours before the first data report is ready for retrieval. After 24 hours, new data is available at the intervals configured using the policy, and is stored for 15 days.

Retrieve and decrypt data

Once you set your data feed configuration settings, it’ll take roughly 24 hours before the first data report is ready for retrieval. After 24 hours, new data is available at the intervals configured using the policy, and is stored for 15 days.

You can then retrieve these reports using an SFTP call. Specifically, you’ll need to:

1. Generate your SFTP access token.
2. Retrieve the data using an SFTP call.
3. Decrypt the downloaded files.

The Knox Guard developer guide walks you through each of these steps while also providing sample code and additional tips where necessary. To learn more, see the Set up analytics data feed tutorial.

Types of data you can retrieve

Currently, the analytics data feed policy supports the retrieval of device list data. This contains all the information available on the Knox Guard device table, and through the Get device info endpoint of the Knox Guard API.

Cancel analytics data collection

If you no longer need to collect data, you can disable this policy at any time.

To cancel data collection, open the Analytics data feed policy page, then click CANCEL DATA COLLECTION at the bottom of the page.