Nexthink Infinity

https://docs.nexthink.com/platform
Admin
Nexthink Infinity is an automation and remediation platform that delivers visibility across all IT...
Tokens:809,541
Snippets:8,022
Trust Score:10
Update:7 months ago
Show doc for...
Tokens:
Raw
### Configure SCCM installer path and parameters

Source: https://docs.nexthink.com/platform/library-packs/security-and-compliance/configuration-manager-sccm-client-health/configuration-guide_-configuration-manager-sccm-client-health

Example configuration for the 'Install Configuration Manager SCCM client' remote action. It demonstrates the expected UNC path format for the installer and the required installation parameters for site communication.

```text
InstallerPath: \\<Configuration Manager server name>\sms_<site code>\Client\CCMSetup.exe
Installation Parameters: /mp:<Configuration Manager server name>/logon SMSSITECODE=<site code>
```

--------------------------------

### GET /installations

Source: https://docs.nexthink.com/platform/latest/nql-data-model

Retrieves the table of package installation events associated with packages, devices, and users.

```APIDOC
## GET /installations

### Description
Retrieves a list of punctual package installation events.

### Method
GET

### Endpoint
/installations

### Parameters
#### Query Parameters
- **context.location.country** (string) - Optional - Country where the device is located.
- **context.location.site** (string) - Optional - Site where the device is located.
- **context.location.state** (string) - Optional - State where the device is located.
- **context.location.type** (string) - Optional - Type of device location (onsite or remote).
- **context.organization.entity** (string) - Optional - Organizational entity of the device.
- **time** (datetime) - Optional - The time of the installation event.

### Response
#### Success Response (200)
- **context.location.country** (string) - Country location.
- **context.location.site** (string) - Site location.
- **context.location.state** (string) - State location.
- **context.location.type** (string) - Location type.
- **context.organization.entity** (string) - Organizational entity.
- **time** (datetime) - Installation time.
```

--------------------------------

### List Packages by Installation Count (Fewest to Most)

Source: https://docs.nexthink.com/platform/user-guide/investigations/investigations-nql-examples

Retrieves a list of all installed packages, ordered by the number of devices they are installed on, from fewest to most. This helps identify less common packages.

```NQL
package.installed_packages
| summarize number_of_packages_installed = count() by package.name
| sort number_of_packages_installed asc
```

--------------------------------

### Guide Executions API

Source: https://docs.nexthink.com/platform/understanding-key-data-platform-concepts/nql-data-model

This endpoint provides details about user interactions with guides, capturing events such as targeting, starting, completion, or closure. It associates these events with specific binaries, devices, users, applications, pages, and guides.

```APIDOC
## GET /websites/nexthink_platform/guide_executions

### Description
Retrieves a list of guide execution events. These events represent user interactions with guides, including when a guide is targeted, started, completed, or closed.

### Method
GET

### Endpoint
/websites/nexthink_platform/guide_executions

### Parameters
#### Query Parameters
- **browser_language** (string) - Optional - The language of the user's browser.
- **context.location.country** (string) - Optional - The country where the device was located at the time of the event.
- **context.location.site** (string) - Optional - The site where the device was located at the time of the event.
- **context.location.state** (string) - Optional - The state where the device was located at the time of the event.
- **context.location.type** (string) - Optional - The type of device location (onsite or remote).
- **context.organization.entity** (string) - Optional - The organizational entity of the device.
- **duration** (duration) - Optional - The duration the guide was visible to the end user.
- **engaged** (enumeration) - Optional - Identifies whether the user engaged with the guide or not. Possible values: targeted, started, completed, closed.
- **execution_id** (uuid) - Optional - The unique identifier of the guide execution.
- **number_of_executions** (integer) - Optional - Used for calculating aggregated metrics. The value for every event is always 1.
- **status** (enumeration) - Optional - The status of the guide execution. Possible values: targeted, started, completed, closed.
- **targeting_count** (integer) - Optional - Used for targeting purposes to count how many times a guide was targeted to the same user on a specific page on the same day.
- **time** (datetime) - Optional - The time of the execution.
- **trigger_method** (enumeration) - Optional - The way the guide was triggered. Possible values: context-help, auto-start, manual, NA.
- **trigger_source** (string) - Optional - A human-readable string for specific interaction types (e.g., Action Button or Journey Name).
- **url** (string) - Optional - The URL where the guide execution happened.

### Response
#### Success Response (200)
- **browser_language** (string) - Browser language.
- **context.location.country** (string) - Country location.
- **context.location.site** (string) - Location -> Site.
- **context.location.state** (string) - State location.
- **context.location.type** (string) - Location type.
- **context.organization.entity** (string) - Organization -> Entity.
- **duration** (duration) - Guide duration.
- **engaged** (enumeration) - Guide engagement.
- **execution_id** (uuid) - Guide execution unique identifier.
- **number_of_executions** (integer) - Number of executions.
- **status** (enumeration) - Guide execution status.
- **targeting_count** (integer) - Guide targeting count.
- **time** (datetime) - Execution time.
- **trigger_method** (enumeration) - Guide trigger method.
- **trigger_source** (string) - Guide trigger source.
- **url** (string) - Guide execution URL.

#### Response Example
{
  "example": "[Example response body for a successful GET request]"
}

#### Error Response (400, 404, 500)
- **error** (string) - Description of the error.

#### Error Response Example
{
  "example": "{\"error\": \"Invalid parameter provided.\"}"
}
```

--------------------------------

### Force-install Nexthink browser extension via Jamf plist

Source: https://docs.nexthink.com/platform/configuring_nexthink/bringing-data-into-your-nexthink-instance/deploying-nexthink-in-non-vdi-environment/installing-the-nexthink-browser-extension

Configuration examples for deploying the Nexthink extension to Chrome, Edge, and Firefox on macOS using Jamf-compatible XML property lists. These configurations set the installation mode to force_installed and define the appropriate update or install URLs.

```XML
<plist version="1.0">
  <dict>
    <key>ExtensionSettings</key>
    <dict>
     <key>miinajhilmmkpdoaimnoncdiliaejpdk</key>
     <dict>
      <key>installation_mode</key>
      <string>force_installed</string>
      <key>update_url</key>
      <string>https://clients2.google.com/service/update2/crx</string>
     </dict>
    </dict>
  </dict>
</plist>
```

```XML
<plist version="1.0">
  <dict>
    <key>ExtensionSettings</key>
    <dict>
     <key>higleibocjmgcnbikjneplkibiopjnkp</key>
     <dict>
      <key>installation_mode</key>
      <string>force_installed</string>
      <key>update_url</key>
      <string>https://edge.microsoft.com/extensionwebstorebase/v1/crx</string>
     </dict>
    </dict>
  </dict>
</plist>
```

```XML
<plist version="1.0">
  <dict>
    <key>EnterprisePoliciesEnabled</key>
    <true/>
    <key>ExtensionSettings</key>
    <dict>
      <key>{393c57f8-28d9-11eb-8f58-3b6871335926}</key>
      <dict>
        <key>installation_mode</key>
        <string>force_installed</string>
        <key>install_url</key>
        <string>https://ffextension.nexthink.com/nexthink-latest-an-fx.xpi</string>
      </dict>
    </dict>
  </dict>
</plist>
```

--------------------------------

### GET /installations

Source: https://docs.nexthink.com/platform/understanding-key-data-platform-concepts/nql-data-model

Retrieves the history of package installation events associated with devices and users.

```APIDOC
## GET /installations

### Description
Retrieves a table of package installation events. These are punctual events associated with a specific package, device, and user.

### Method
GET

### Endpoint
/installations

### Parameters
#### Query Parameters
- **time** (datetime) - Optional - Filter by installation time

### Response
#### Success Response (200)
- **context.location.country** (string) - Country location of the device.
- **context.location.site** (string) - Site location of the device.
- **context.location.state** (string) - State location of the device.
- **context.location.type** (string) - Type of device location (onsite or remote).
- **context.organization.entity** (string) - Organizational entity of the device.
- **time** (datetime) - The time of the installation event.
```

--------------------------------

### NXQL: Querying Recent Connection Events

Source: https://docs.nexthink.com/platform/configuring_nexthink/bringing-data-into-your-nexthink-instance/integrating-nexthink-with-third-party-tools/api-and-integrations-classic/nxql-api-classic/nxql-tutorial-classic

Retrieves the last 100 connection events, ordered by start time in descending order. This example shows how to directly query event tables and filter by specific criteria like executable name.

```NXQL
(select (start_time end_time incoming_traffic outgoing_traffic)
   (from connection
       (where binary (eq executable_name (pattern firefox.exe)))
       (between midnight-1d midnight))
   (limit 100)
   (order_by start_time desc))
```

--------------------------------

### Installed Services API

Source: https://docs.nexthink.com/platform/understanding-key-data-platform-concepts/nql-data-model

Provides information about all services currently installed on all devices. This includes details like when the service was first seen and its startup type.

```APIDOC
## GET /websites/nexthink_platform/installed_services

### Description
Retrieves a list of all services currently installed on devices, along with their details.

### Method
GET

### Endpoint
/websites/nexthink_platform/installed_services

### Parameters
#### Query Parameters
- **first_seen** (datetime) - Optional - Timestamp when the service was first seen on the given device.
- **last_updated** (datetime) - Optional - Timestamp of the last recorded change to the service on the given device.
- **logon_as** (string) - Optional - Account under which the service runs.
- **startup_type** (enumeration) - Optional - Startup type of the service ('Automatic', 'Manual', 'Disabled', 'Delayed').

### Response
#### Success Response (200)
- **first_seen** (datetime) - Timestamp when the service was first seen on the given device.
- **last_updated** (datetime) - Timestamp of the last recorded change to the service on the given device.
- **logon_as** (string) - Account under which the service runs.
- **startup_type** (enumeration) - Startup type of the service.

#### Response Example
{
  "installed_services": [
    {
      "first_seen": "2023-01-15T08:30:00Z",
      "last_updated": "2023-10-26T14:45:00Z",
      "logon_as": "Local System",
      "startup_type": "Automatic"
    }
  ]
}
```

--------------------------------

### Installed Packages API

Source: https://docs.nexthink.com/platform/understanding-key-data-platform-concepts/nql-data-model

Retrieves a list of all installed packages on all devices. Installed packages are associated with devices, users, and packages.

```APIDOC
## GET /websites/nexthink_platform/installed_packages

### Description
Retrieves a table of all installed packages on all devices. Installed packages are associated with devices, users, and packages.

### Method
GET

### Endpoint
/websites/nexthink_platform/installed_packages

### Parameters
#### Query Parameters
- **first_seen** (datetime) - Optional - The date and time the package was first detected by Nexthink.
- **name** (string) - Optional - The name of the packages as it is listed in the operating system.
- **parent_name** (string) - Optional - The name of the original package for which an update was installed.
- **platform** (enumeration) - Optional - The operating system platform to which the installed package belongs (Windows, macOS).
- **publisher** (string) - Optional - The name of the company that publishes the software.
- **type** (enumeration) - Optional - Indicates whether the package contains a program or an update (Program, Update).
- **uid** (uuid) - Optional - The numerical value that uniquely identifies a package in Nexthink.
- **version** (string) - Optional - The version of the package, stored as a string.

### Response
#### Success Response (200)
- **first_seen** (datetime) - The date and time the package was first detected.
- **name** (string) - The name of the package.
- **parent_name** (string) - The name of the parent package (for updates).
- **platform** (enumeration) - The operating system platform of the package.
- **publisher** (string) - The publisher of the package.
- **type** (enumeration) - The type of the package (Program or Update).
- **uid** (uuid) - The unique identifier of the package.
- **version** (string) - The version of the package.

#### Response Example
{
  "installed_packages": [
    {
      "first_seen": "2023-10-26T09:00:00Z",
      "name": "Microsoft Office",
      "parent_name": null,
      "platform": "Windows",
      "publisher": "Microsoft",
      "type": "Program",
      "uid": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
      "version": "16.0.16827.20130"
    }
  ]
}
```

--------------------------------

### GET /packages

Source: https://docs.nexthink.com/platform/understanding-key-data-platform-concepts/nql-data-model

Retrieves the list of software packages detected on devices across the Nexthink platform.

```APIDOC
## GET /packages

### Description
Retrieves a table of software packages. A package is defined as a group of files and executables that constitute a software application.

### Method
GET

### Endpoint
/packages

### Parameters
#### Query Parameters
- **uid** (uuid) - Optional - Unique identifier for the package
- **name** (string) - Optional - Filter by package name

### Response
#### Success Response (200)
- **first_seen** (datetime) - Date and time the package was first detected.
- **name** (string) - Name of the package as listed in the OS.
- **parent_name** (string) - Name of the original package for updates.
- **platform** (enumeration) - Operating system (Windows, macOS).
- **publisher** (string) - Company that publishes the software.
- **type** (enumeration) - Type of package (Program, Update).
- **uid** (uuid) - Unique identifier for the package.
- **version** (string) - Version of the package.
```

--------------------------------

### Guides API

Source: https://docs.nexthink.com/platform/understanding-key-data-platform-concepts/nql-data-model

Retrieve information about guides, which represent any type of guidance for end users, including walkthroughs, tooltips, and documents.

```APIDOC
## GET /websites/nexthink_platform/guides

### Description
Retrieves a list of guides.

### Method
GET

### Endpoint
/websites/nexthink_platform/guides

### Parameters
#### Query Parameters
- **name** (string) - Optional - Filter by guide name.
- **nql_id** (uuid) - Optional - Filter by guide unique identifier.
- **type** (enumeration) - Optional - Filter by guide type (Walkthrough, Tooltip, Document).

### Response
#### Success Response (200)
- **name** (string) - Name of the guide.
- **nql_id** (uuid) - Unique identifier of the guide.
- **type** (enumeration) - Type of the guide.

#### Response Example
{
  "example": "[{\"name\": \"Onboarding Walkthrough\", \"nql_id\": \"f0e1d2c3-b4a5-6789-0123-456789abcdef\", \"type\": \"Walkthrough\"}, {\"name\": \"VPN Setup Guide\", \"nql_id\": \"a1b2c3d4-e5f6-7890-1234-567890fedcba\", \"type\": \"Document\"}]"
}
```

--------------------------------

### GET /devices

Source: https://docs.nexthink.com/platform/understanding-key-data-platform-concepts/nql-data-model

Retrieves the list of monitored devices and their associated metadata, including boot information, collector status, and connectivity details.

```APIDOC
## GET /devices

### Description
Retrieves a comprehensive list of devices monitored by the Nexthink Collector. This endpoint provides details on device configuration, collector status, and network connectivity.

### Method
GET

### Endpoint
/devices

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - Number of devices to return.
- **offset** (integer) - Optional - Number of records to skip.

### Response
#### Success Response (200)
- **ad_site** (string) - AD site assignment.
- **boot.days_since_last_full_boot** (integer) - Days since last full boot.
- **collector.uid** (uuid) - Unique identifier of the Collector.
- **collector.version** (version) - Installed Collector version.
- **connectivity.last_connectivity_type** (enumeration) - Last network adapter type (WiFi, Ethernet, Bluetooth).

#### Response Example
{
  "devices": [
    {
      "ad_site": "HQ-Office",
      "boot": {
        "days_since_last_full_boot": 5
      },
      "collector": {
        "uid": "550e8400-e29b-41d4-a716-446655440000",
        "version": "6.28.0"
      },
      "connectivity": {
        "last_connectivity_type": "Ethernet"
      }
    }
  ]
}
```

--------------------------------

### Session Start Time API

Source: https://docs.nexthink.com/platform/understanding-key-data-platform-concepts/nql-data-model

Retrieves the start time of a user's collaboration session.

```APIDOC
## GET /websites/nexthink_platform/session_start_time

### Description
Retrieves the time when a user joined a collaboration call.

### Method
GET

### Endpoint
/websites/nexthink_platform/session_start_time

### Response
#### Success Response (200)
- **start_time** (datetime) - The time when the user joined the call.

#### Response Example
```json
{
  "start_time": "2023-10-27T10:00:00Z"
}
```
```

--------------------------------

### Time Bucket Metric

Source: https://docs.nexthink.com/platform/understanding-key-data-platform-concepts/nql-data-model

This section details the metric for the start time of a time bucket.

```APIDOC
## Time Bucket Metric

### Description
Provides the start time of a time bucket.

### Method
GET

### Endpoint
/websites/nexthink_platform/metrics

### Parameters
#### Query Parameters
- **metric_name** (string) - Required - The name of the metric to retrieve. Value must be `start_time`.

### Request Example
```json
{
  "metric_name": "start_time"
}
```

### Response
#### Success Response (200)
- **value** (datetime) - The start time and date of the time bucket.

#### Response Example
```json
{
  "value": "2023-10-27T10:00:00Z"
}
```
```

--------------------------------

### Service Installations API

Source: https://docs.nexthink.com/platform/understanding-key-data-platform-concepts/nql-data-model

Retrieves events triggered when a service is added to or removed from a specific device. These are punctual events associated with a service and a device.

```APIDOC
## GET /websites/nexthink_platform/installations

### Description
Retrieves a list of service installation and uninstallation events for devices.

### Method
GET

### Endpoint
/websites/nexthink_platform/installations

### Parameters
#### Query Parameters
- **context.location.country** (string) - Optional - Country where the device is located at the time of the event.
- **context.location.site** (string) - Optional - Site where the device is located at the time of the event.
- **context.location.state** (string) - Optional - State where the device is located at the time of the event.
- **context.location.type** (string) - Optional - Type of device location (onsite or remote) at the time of the event.
- **context.organization.entity** (string) - Optional - Organizational entity of the device at the time of the event.
- **event_type** (enumeration) - Optional - Type of installation event; possible values are 'install' and 'uninstall'.
- **time** (datetime) - Optional - Timestamp indicating when the item was detected as added or removed.

### Response
#### Success Response (200)
- **context.location.country** (string) - Country location of the device.
- **context.location.site** (string) - Site location of the device.
- **context.location.state** (string) - State location of the device.
- **context.location.type** (string) - Type of device location.
- **context.organization.entity** (string) - Organizational entity of the device.
- **event_type** (enumeration) - Type of installation event ('install' or 'uninstall').
- **time** (datetime) - Timestamp of the event.

#### Response Example
{
  "installations": [
    {
      "context": {
        "location": {
          "country": "USA",
          "site": "New York",
          "state": "NY",
          "type": "onsite"
        },
        "organization": {
          "entity": "IT Department"
        }
      },
      "event_type": "install",
      "time": "2023-10-27T10:00:00Z"
    }
  ]
}
```

--------------------------------

### GET /sessions

Source: https://docs.nexthink.com/platform/understanding-key-data-platform-concepts/nql-data-model

Retrieves a collection of collaboration sessions performed with tools such as Teams or Zoom, including detailed audio performance metrics.

```APIDOC
## GET /sessions

### Description
Retrieves a list of collaboration sessions. These are punctual events associated with a user and a device, providing insights into application performance and audio quality.

### Method
GET

### Endpoint
/sessions

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - Number of sessions to return.
- **offset** (integer) - Optional - Pagination offset.

### Response
#### Success Response (200)
- **application.type** (enumeration) - The type of application (Teams, Zoom).
- **application.version** (version) - The version of the application used.
- **audio.inbound_jitter** (duration) - Average change in delay for inbound audio packets.
- **audio.inbound_latency** (duration) - Time for inbound audio packet to reach device (Zoom only).
- **audio.inbound_packet_loss** (float) - Ratio of inbound audio packets lost.
- **audio.inbound_rocs** (float) - Ratio of audio frames generated by packet loss healing (Teams only).
- **audio.inbound_rtt** (duration) - Round trip time for audio packets (Teams only).
- **audio.outbound_jitter** (duration) - Average change in delay for outbound audio packets.

#### Response Example
{
  "sessions": [
    {
      "application": {
        "type": "Teams",
        "version": "1.5.00.123"
      },
      "audio": {
        "inbound_jitter": "15ms",
        "inbound_packet_loss": 0.02,
        "inbound_rocs": 0.01,
        "inbound_rtt": "120ms",
        "outbound_jitter": "10ms"
      }
    }
  ]
}
```

--------------------------------

### GET /websites/nexthink_platform/mobile_devices

Source: https://docs.nexthink.com/platform/understanding-key-data-platform-concepts/nql-data-model

Retrieves a list of all mobile devices monitored by the Nexthink platform. This endpoint allows you to fetch comprehensive details for each mobile device, including hardware specifications, compliance status, and last seen information.

```APIDOC
## GET /websites/nexthink_platform/mobile_devices

### Description
Retrieves a list of all mobile devices monitored by the Nexthink platform. This endpoint allows you to fetch comprehensive details for each mobile device, including hardware specifications, compliance status, and last seen information.

### Method
GET

### Endpoint
/websites/nexthink_platform/mobile_devices

### Parameters
#### Query Parameters
- **days_since_last_seen** (integer) - Optional - Days since last seen: The number of days since the last time the mobile device was seen active by the Nexthink instance.
- **governance.compliance_state** (string) - Optional - Compliance state: The current compliance status of the device as reported by the MDM.
- **governance.enrollment_type** (string) - Optional - Enrollment type: Defines how the device was enrolled into MDM management.
- **governance.is_encrypted** (bool) - Optional - Encryption enabled: Indicates whether the device storage is encrypted.
- **governance.is_supervised** (bool) - Optional - Supervised device: Indicates if the device is supervised by the MDM, allowing deeper management capabilities.
- **governance.last_synced** (datetime) - Optional - Last synced: The last time the MDM successfully synced data with the device.
- **governance.name** (string) - Optional - Managed device name: The device name as assigned in the Mobile Device Management (MDM) system.
- **governance.ownership_type** (string) - Optional - Ownership type: Specifies whether the device is company-owned or personally-owned.
- **hardware.battery_type** (enumeration) - Optional - Battery type: The battery type of the installed battery.
- **hardware.imei** (string) - Optional - IMEI: The International Mobile Equipment Identity (IMEI) of the device.
- **hardware.main_display.diagonal** (float) - Optional - Diagonal size: The physical size of the display in inches.
- **hardware.main_display.horizontal** (integer) - Optional - Horizontal: The horizontal size of the main display in px.
- **hardware.main_display.vertical** (integer) - Optional - Vertical: The vertical size of the main display in px.
- **hardware.manufacturer** (string) - Optional - Manufacturer: The name of the mobile device manufacturer.
- **hardware.memory** (bytes) - Optional - Available memory: The total amount of random-access memory (RAM) available to the system.
- **hardware.model** (string) - Optional - Device model: The model of the device.
- **hardware.remaining_battery_capacity** (numeric) - Optional - Remaining capacity of the battery: The remaining capacity of the installed battery.
- **hardware.serial_number** (string) - Optional - Serial number: The hardware serial number of the device.
- **last_seen** (datetime) - Optional - Last seen: The date and time of the last mobile device activity received by the Nexthink instance.
- **name** (string) - Optional - Name: The name of the mobile device as used by the operating system.

### Response
#### Success Response (200)
- **days_since_last_seen** (integer) - Days since last seen: The number of days since the last time the mobile device was seen active by the Nexthink instance.
- **governance.compliance_state** (string) - Compliance state: The current compliance status of the device as reported by the MDM.
- **governance.enrollment_type** (string) - Enrollment type: Defines how the device was enrolled into MDM management.
- **governance.is_encrypted** (bool) - Encryption enabled: Indicates whether the device storage is encrypted.
- **governance.is_supervised** (bool) - Supervised device: Indicates if the device is supervised by the MDM, allowing deeper management capabilities.
- **governance.last_synced** (datetime) - Last synced: The last time the MDM successfully synced data with the device.
- **governance.name** (string) - Managed device name: The device name as assigned in the Mobile Device Management (MDM) system.
- **governance.ownership_type** (string) - Ownership type: Specifies whether the device is company-owned or personally-owned.
- **hardware.battery_type** (enumeration) - Battery type: The battery type of the installed battery.
- **hardware.imei** (string) - IMEI: The International Mobile Equipment Identity (IMEI) of the device.
- **hardware.main_display.diagonal** (float) - Diagonal size: The physical size of the display in inches.
- **hardware.main_display.horizontal** (integer) - Horizontal: The horizontal size of the main display in px.
- **hardware.main_display.vertical** (integer) - Vertical: The vertical size of the main display in px.
- **hardware.manufacturer** (string) - Manufacturer: The name of the mobile device manufacturer.
- **hardware.memory** (bytes) - Available memory: The total amount of random-access memory (RAM) available to the system.
- **hardware.model** (string) - Device model: The model of the device.
- **hardware.remaining_battery_capacity** (numeric) - Remaining capacity of the battery: The remaining capacity of the installed battery.
- **hardware.serial_number** (string) - Serial number: The hardware serial number of the device.
- **last_seen** (datetime) - Last seen: The date and time of the last mobile device activity received by the Nexthink instance.
- **name** (string) - Name: The name of the mobile device as used by the operating system.

#### Response Example
```json
[
  {
    "days_since_last_seen": 5,
    "governance": {
      "compliance_state": "Compliant",
      "enrollment_type": "DEP",
      "is_encrypted": true,
      "is_supervised": true,
      "last_synced": "2023-10-27T10:00:00Z",
      "name": "MyCompany-iPhone-123",
      "ownership_type": "Company"
    },
    "hardware": {
      "battery_type": "Li-ion",
      "imei": "123456789012345",
      "main_display": {
        "diagonal": 6.1,
        "horizontal": 1170,
        "vertical": 2532
      },
      "manufacturer": "Apple",
      "memory": 128000000000,
      "model": "iPhone 12",
      "remaining_battery_capacity": 4500,
      "serial_number": "ABCDEF123456"
    },
    "last_seen": "2023-10-27T09:55:00Z",
    "name": "John's iPhone"
  }
]
```
```

--------------------------------

### GET /api/v1/application-metrics

Source: https://docs.nexthink.com/platform/understanding-key-data-platform-concepts/nql-data-model

Retrieves performance metrics for monitored web applications, including network time, overall load time, and response metadata.

```APIDOC
## GET /api/v1/application-metrics

### Description
Retrieves performance metrics for web applications defined in the Nexthink configuration. Requires the Nexthink browser extension to be active on client devices.

### Method
GET

### Endpoint
/api/v1/application-metrics

### Parameters
#### Query Parameters
- **start_time** (datetime) - Optional - Filter results from this timestamp
- **url** (string) - Optional - Filter metrics by specific navigation URL

### Request Example
{
  "url": "https://example.com",
  "time_range": "last_24h"
}

### Response
#### Success Response (200)
- **page_load_time.network** (duration) - Network latency in milliseconds
- **page_load_time.overall** (duration) - Total page load time in milliseconds
- **response_size** (bytes) - Size of the HTTP response
- **url** (string) - The recorded navigation URL
- **start_time** (datetime) - Bucket start timestamp

#### Response Example
{
  "page_load_time": {
    "network": 150,
    "overall": 1200
  },
  "response_size": 45023,
  "url": "https://example.com",
  "start_time": "2023-10-27T10:00:00Z"
}
```

--------------------------------

### GET /connections/events

Source: https://docs.nexthink.com/platform/understanding-key-data-platform-concepts/nql-data-model

Retrieves sampled connection events for outgoing TCP and UDP traffic, including associated binary, device, user, and network application metadata.

```APIDOC
## GET /connections/events

### Description
Retrieves sampled events for outgoing TCP connections and UDP packages. Metrics are associated with binaries, users, devices, and applications.

### Method
GET

### Endpoint
/connections/events

### Parameters
#### Query Parameters
- **bucket_duration** (duration) - Optional - Bucket duration (Exclusive to Nexthink Infinity).

### Response
#### Success Response (200)
- **context.location.country** (string) - Country where the device is located.
- **context.location.site** (string) - Site where the device is located.
- **context.location.state** (string) - State where the device is located.
- **context.location.type** (string) - Type of device location (onsite or remote).
- **context.organization.entity** (string) - Organizational entity of the device.
- **destination.country** (string) - Country of the destination based on GeoIP.
- **destination.datacenter_region** (string) - Region of the data center.
- **destination.domain** (string) - DNS domain name of the destination.
- **destination.ip_address** (ipAddress) - IPv4 or IPv6 address of the destination.
- **destination.ip_subnet** (ipAddress) - Network address of the destination.
- **destination.owner** (string) - Owner of the destination (AS, data center operator, or intranet).
- **destination.port** (numeric) - Network port number.

#### Response Example
{
  "context": {
    "location": {
      "country": "United States",
      "site": "HQ-Building-A",
      "type": "onsite"
    }
  },
  "destination": {
    "ip_address": "192.168.1.1",
    "port": 443,
    "owner": "Intranet"
  }
}
```

--------------------------------

### GET /devices/{device_id}/volumes

Source: https://docs.nexthink.com/platform/understanding-key-data-platform-concepts/nql-data-model

Retrieves the list of logical storage volumes associated with a specific device, including capacity and usage metrics.

```APIDOC
## GET /devices/{device_id}/volumes

### Description
Retrieves the list of logical storage volumes for a specified device. This includes capacity in bytes, volume name, system volume status, and usage percentage.

### Method
GET

### Endpoint
/devices/{device_id}/volumes

### Parameters
#### Path Parameters
- **device_id** (string) - Required - The unique identifier of the device.

### Request Example
GET /devices/12345/volumes

### Response
#### Success Response (200)
- **capacity** (bytes) - The volume capacity in bytes.
- **name** (string) - The name of the volume.
- **system** (bool) - Indicates if the volume contains the operating system.
- **usage** (percentage) - The volume usage in percent.

#### Response Example
[
  {
    "capacity": 512000000000,
    "name": "C:",
    "system": true,
    "usage": 45.5
  }
]
```

--------------------------------

### Get Hard Resets

Source: https://docs.nexthink.com/platform/understanding-key-data-platform-concepts/nql-data-model

Retrieves a list of hard reset events associated with devices. Hard resets indicate situations where a device rebooted unexpectedly, such as freezing or power outages.

```APIDOC
## GET /websites/nexthink_platform/hard_resets

### Description
Retrieves a list of hard reset events associated with devices. Hard resets indicate situations where a device rebooted unexpectedly, such as freezing or power outages.

### Method
GET

### Endpoint
/websites/nexthink_platform/hard_resets

### Parameters
#### Query Parameters
- **context.location.country** (string) - Optional - Country location: Country where the device is located at the time of the event, determined by rule-based location or geolocation.
- **context.location.site** (string) - Optional - Location -> Site: Site where the device is located at the time of the event, determined by rule-based location.
- **context.location.state** (string) - Optional - State location: State where the device is located at the time of the event, determined by rule-based location or geolocation.
- **context.location.type** (string) - Optional - Location type: Type of device location (onsite or remote) at the time of the event, determined by rule-based location.
- **context.organization.entity** (string) - Optional - Organization -> Entity: Organizational entity of the device at the time of the event, determined by rule-based organization.
- **number_of_hard_resets** (integer) - Optional - Number of hard resets: The number of hard resets.
- **time** (datetime) - Optional - Time: The date and time of the crash.

### Response
#### Success Response (200)
- **context.location.country** (string) - Country where the device is located.
- **context.location.site** (string) - Site where the device is located.
- **context.location.state** (string) - State where the device is located.
- **context.location.type** (string) - Type of device location (onsite or remote).
- **context.organization.entity** (string) - Organizational entity of the device.
- **number_of_hard_resets** (integer) - The number of hard resets.
- **time** (datetime) - The date and time of the crash.

#### Response Example
{
  "hard_resets": [
    {
      "context": {
        "location": {
          "country": "USA",
          "site": "New York Office",
          "state": "NY",
          "type": "onsite"
        },
        "organization": {
          "entity": "IT Department"
        }
      },
      "number_of_hard_resets": 1,
      "time": "2023-10-27T10:00:00Z"
    }
  ]
}
```

--------------------------------

### GET /executions

Source: https://docs.nexthink.com/platform/understanding-key-data-platform-concepts/nql-data-model

Retrieves a collection of executed remote actions, which are punctual events associated with devices, users, and specific remote actions.

```APIDOC
## GET /executions

### Description
Retrieves the list of executed remote actions. Executions are punctual events that track the lifecycle of remote actions triggered on devices.

### Method
GET

### Endpoint
/executions

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - Number of records to return
- **offset** (integer) - Optional - Number of records to skip

### Response
#### Success Response (200)
- **message_uuid** (string) - The unique identifier of the remote action execution.
- **request_id** (string) - The unique identifier for the request that created this execution.
- **status** (enumeration) - Current status (e.g., in_progress, success, failure).
- **request_time** (datetime) - Date and time when the execution was triggered.
- **time** (datetime) - Date and time the execution was last updated.
- **context.location.country** (string) - Country where the device is located.
- **inputs** (string) - List of inputs provided for the execution.
- **outputs** (string) - List of outputs collected by the execution.

#### Response Example
{
  "message_uuid": "550e8400-e29b-41d4-a716-446655440000",
  "status": "success",
  "request_time": "2023-10-27T10:00:00Z",
  "context": {
    "location": {
      "country": "USA"
    }
  },
  "inputs": "{\"param1\": \"value\"}",
  "outputs": "{\"result\": \"success\"}"
}
```

--------------------------------

### NXQL: Querying Devices with Specific Packages

Source: https://docs.nexthink.com/platform/configuring_nexthink/bringing-data-into-your-nexthink-instance/integrating-nexthink-with-third-party-tools/api-and-integrations-classic/nxql-api-classic/nxql-tutorial-classic

Demonstrates how to use the 'package' keyword in NXQL to filter devices based on installed software. It shows how 'package' can act as a relationship table to link devices to their installed packages.

```NXQL
(select (name)
   (from device
       (with package
           (where package (eq name (pattern "Microsoft Office 365 ProPlus*"))))))
```

```NXQL
(select ((device (name)) (package (version name publisher)))
   (from (device package)
       (with package
            (where package
               (eq name (pattern "Microsoft Office 365 ProPlus*"))
               (eq type (enum program)))))
   (limit 10000))
```

```NXQL
(select (name)
   (from device
       (with package
           (compute number_of_packages))))
```

--------------------------------

### Query Software Metering API for Details (JSON)

Source: https://docs.nexthink.com/platform/configuring_nexthink/bringing-data-into-your-nexthink-instance/integrating-nexthink-with-third-party-tools/api-and-integrations-classic/other-integrations-classic/software-metering-api-classic

Example of a GET request to the Software Metering API to retrieve installed software details in JSON format. It includes parameters for metric, hierarchy, program, and path.

```plaintext
https://<Portal_DNS_FQDN>/api/softwaremetering/v1/details?
metric=52fa2b8b-b35e-4d7a-9db3-830617c5b6b2&
hierarchy=DefaultHierarchy&
program=8b37ddb4-29fe-469a-bdc0-ca3497d7c7f9&
list=installed&
path=Europe&path=Switzerland&path=Lausanne&
format=json
```

--------------------------------

### Allowlist Format Example

Source: https://docs.nexthink.com/platform/references/database-information-and-organization/application-startup-duration

Demonstrates the format for defining the allowlist of executable names for application startup duration measurement. The asterisk can be used as a wildcard.

```shell
"winword.exe,excel.exe,onenote*"
```

--------------------------------

### Configure Installation Parameters for Configuration Manager Client

Source: https://docs.nexthink.com/platform/library-packs/security-and-compliance/workflow_-configuration-manager-sccm-client-continuity/configuration-guide-configuration-manager-sccm-client-continuity

Defines additional settings passed to the Configuration Manager client during installation. Recommended parameters ensure a fully functional client immediately after installation.

```text
InstallationParameters: "/mp:<Configuration Manager server name> /logon SMSSITECODE=<site code>"
```

--------------------------------

### List Packages by Installation Count (Most to Fewest)

Source: https://docs.nexthink.com/platform/user-guide/investigations/investigations-nql-examples

Retrieves a list of all installed packages, ordered by the number of devices they are installed on, from most to fewest. This helps identify the most common packages.

```NQL
package.installed_packages
| summarize number_of_packages_installed = count() by package.name
| sort number_of_packages_installed desc
```

--------------------------------

### Open Device View with Connection Details (URI)

Source: https://docs.nexthink.com/platform/configuring_nexthink/bringing-data-into-your-nexthink-instance/integrating-nexthink-with-third-party-tools/api-and-integrations-classic/other-integrations-classic/bidirectional-integration-with-finder-classic

This URI example demonstrates how to open the device view on a specific connection by providing explicit connection details such as Host, Port, UserName, and EngineName. This method ensures a direct and targeted connection to the desired Nexthink Portal and Engine.

```uri
nxt://Show-NxSource?Name=SOURCE_NAME&Host=PORTAL_ADDRESS&Port=PORT_NUMBER&UserName=USER&EngineName=ENGINE
```

--------------------------------

### Execute Nexthink Collector Installation Command

Source: https://docs.nexthink.com/platform/configuring_nexthink/bringing-data-into-your-nexthink-instance/deploying-nexthink-in-non-vdi-environment/installing-collector/installing-collector-on-macos

This command initiates the installation of the Nexthink Collector using the `csi` application. It requires several mandatory arguments such as the Nexthink instance address, port, TCP port, and customer key. Optional arguments allow for further customization of the installation, including campaign settings, data transmission, remote action policies, and proxy configuration.

```bash
sudo ./csi address=<FQDN> port=<port> tcp_port=<port> rootca=<path> key=<path> [engage=<enable/disable>] [data_over_tcp=<enable/disable>] [use_assignment=<enable/disable>] [ra_execution_policy=<policy>] [tag=<integer>] [string_tag=<string>] [proxy_pac_address=<URL>] [proxy_address=<FQDN>] [proxy_port=<port>]
```

--------------------------------

### GET /installed_packages

Source: https://docs.nexthink.com/platform/latest/nql-data-model

Retrieves the inventory of all installed packages across all devices.

```APIDOC
## GET /installed_packages

### Description
Retrieves the table of all installed packages on all devices.

### Method
GET

### Endpoint
/installed_packages

### Parameters
#### Query Parameters
- **name** (string) - Optional - Package name.
- **platform** (enumeration) - Optional - Windows or macOS.
- **uid** (uuid) - Optional - Unique package identifier.

### Response
#### Success Response (200)
- **first_seen** (datetime) - Date and time first detected.
- **name** (string) - Package name.
- **parent_name** (string) - Parent package name for updates.
- **platform** (enumeration) - Windows or macOS.
- **publisher** (string) - Software publisher.
- **type** (enumeration) - Program or Update.
- **uid** (uuid) - Package UID.
- **version** (string) - Package version string.
```

--------------------------------

### NXQL: Set Operations on Device Lists

Source: https://docs.nexthink.com/platform/configuring_nexthink/bringing-data-into-your-nexthink-instance/integrating-nexthink-with-third-party-tools/api-and-integrations-classic/nxql-api-classic/nxql-tutorial-classic

Illustrates how to perform set operations (except, union, intersect) on lists of devices in NXQL. This allows for complex filtering, such as finding devices that do *not* have a specific package installed.

```NXQL
(select (name)
   (except
       (from device)   - list of all devices
       (from device    - list of device with Office
           (with package
               (where package (eq name (pattern *Microsoft*Office*)))))))
```
Tokens:
Raw