Skip Navigation

Get focus view results

Get the details of an existing focus view that is used to generate the chart and table in the UI.
Service endpoint
/foci/v2/{{focus_id}}/results
Optional query string parameters
Example
https://protectapi.cylance.com/foci/v2/A0AC3D2117C40D0576CED0D99069E96G/results
Method
HTTP/1.1 GET
Request headers
  • Accept: application/json
  • Authorization: Bearer
    JWT Token returned by Auth API
    with the opticsfocus:read scope encoded

Request

None

Response

Please see the Response status codes for more information.

Response JSON schema

Field Name
Description
id
This is the unique ID of the focus view.
status
This is the status of the focus view result or request. The possible values are:
  • AVAILABLE: A focus view has been generated and is available for viewing.
  • PENDING: The focus view has been requested.
  • REQUEST: The focus viewhas not been generated, but it can be requested.
  • RETRY_REQUEST: The focus view has not been generated. It was previously requested but no results were received. It can be requested again.
  • DOES_NOT_EXIST: The focus view requested on the device cannot be completed because the requested parameters do not exist on the device.
  • UNAVAILABLE: The focus view is not available, and the associated device is not online to fulfill the request. It can be requested at a later time.
  • UNKNOWN_DEVICE: The focus view is not available, and the associated device is no longer known.
result
This is the large structure of data that is used to generate the focus view chart and table in the UI. This field will only be populated if the status field is
AVAILABLE
.
Parsing this data is beyond the scope of this guide.