Monitor miscellaneous data

The Knox Asset Intelligence APIs enable you to monitor data from the devices in your tenant, such as the status of events related to the Knox Service Plugin app. This tutorial shows you how to retrieve information related to Knox Service Plugin app for a specified time period.

Prerequisites

Ensure that you have the necessary permissions to set or update the Knox Asset Intelligence settings and obtain an authentication token. For more information, see Get started.

Get Knox Service Plugin app status

1. To retrieve information about Knox Service Plugin app status of devices, make a POST request to the /miscellaneous/getKspStatus endpoint.

2. In the request body, you can use the following optional parameters:

   • pageNum — Page number to retrieve.
   • pageSize — Number of items on a page.
   • deviceIds — List of the device IMEIs or serial numbers for targeted retrieval.
   • kspStatus — List the Knox Service Plugin app statuses that you want information for, its possible values are Success, Partial success, and Fail. If the last status is Partial success or Fail, a failure report is provided in the response.
   • startDate — Start time and date in milliseconds using Unix timestamp.
   • endDate — End time and date in milliseconds using Unix timestamp.
   • groupName — Name of the Knox Asset Intelligence device group you want information about. If this parameter is set to null, then all the groups are searched.

For example, the following request sample gives the Knox Service Plugin app status and details such as version, profile name, status, policy report, and policy schema for the device ID 111111112222222, in the timeframe between 1702612800000 and 17026128010000 timestamps.

{
  "pageNum": 0,
  "pageSize": 10,
  "deviceIds": [
    "111111112222222"
  ],
  "kspStatus": [
    "Success",
    "Partial success",
    "Fail"
  ],
  "startDate": 1702612800000,
  "endDate": 17026128010000
}

You can adjust the parameter values in the request body according to the kind of information you want to fetch, for example you can specify device ID, time period, kspstatus, or groupName. For detailed response schema, see POST /getKspStatus.

Ensure that you check the code and message in the response for any errors and handle them appropriately for your app. For detailed specification, see Knox Asset Intelligence API.