Adopt NQL capabilities

This page highlights the Adopt-specific NQL data model—comprising namespaces and tables—to query guide-related data.

Adopt-specific NQL tables

Refer to the NQL data model for more details about the Adopt-specific tables.

Adopt mainly uses the following NQL tables:

• application.guide: This table represents the guide object, which is any type of guidance provided to end-users, such as walkthroughs, tooltips, or media documents.

• application.guide_step: This table represents an individual-step object within a Walkthrough-type guide.

• web.context_help_executions: This table tracks employee interactions with Context Help elements from the web application (e.g., clicking the question mark icon, searching guides).

• web.guide_executions: This table records the execution event of a guide, which can occur multiple times for each employee using the target web application.

• web.guide_step_executions: This table captures employee interactions with individual steps within a guide.

These tables track user interactions with guides, steps within guides, and Context help executions. The data can be leveraged to understand employee behavior and guide engagement within Nexthink Adopt.

Key benefits of the new metrics:

• Querying guide engagement: Use the new fields to track guide targeting, engagement, execution duration, and other user interaction metrics.

• Increasing guide-related data granularity: By adjusting the data granularity, you can gain precise insights into how employees interact with guides, such as the exact timing of when an end-user engages with specific steps or elements.

Adopt-related configuration objects in the application NQL namespace

guide table fields

The example below uses nql_idfield object from the guide table of the application NQL namespace.

application.guides 
| list nql_id 

Field Name	Description
nql_id	Unique identifier for the guide.
name	Unique identifier for the guide.
type	Type of guide (e.g., Walkthrough, Tooltip, Media).
status	Status of the guide (e.g., Published, Draft).

guide_step table fields

The example below uses rankfield object from the guide_step table of the application NQL namespace.

application.guide_steps 
| sort rank asc 
| limit 10 

guide_step table field	Description
nql_id	Unique identifier for the guide step.
name	Name of the guide step.
type	Type of step (e.g., Walkthrough Step, Action, Decision).
rank	Position or sequence of the step in the guide.
guide_nql_id	Relation to the guide identifier containing this step.

Adopt-related events in the web NQL namespace

context_help_executions table fields

The example below uses browser_languagefield event from the context_help_executions table of the web NQL namespace.

web.context_help_executions during past 24h
| sort browser_language desc

context_help_executions table field	Description
execution_id	Unique identifier for the Context Help execution.
status	Status of the Context Help execution: open, closed.
url	The URL where the interaction occurred.
duration	Duration the Context Help remained open.
browser_language	Language of the user's browser fro Context Help executions.
number_of_executions	Used for calculating aggregated metrics in NQL (always 1 for each event).

guide_executions table fields

The example below uses statusfield event from the guide_executions table of the web NQL namespace.

web.guide_executions from 2025-02-03 11:00:00 to Feb 4, 2025, 11 AM
| list status

guide_executions table field	Description
execution_id	Unique identifier for the guide execution.
status	Status of the guide execution. targeted: The guide was targeted to the user (the guide was made available to the user). started: The guide execution began, and the user interacted with it. completed: The guide execution was completed by the user. closed: The guide was closed by the user before completing or completing its steps.
number_of_executions	Used for calculating aggregated metrics in NQL. The value for every event is always 1.
duration	Duration the guide was visible to the end-user.
browser_language	Language of the user's browser for guide executions.
targeting_count	Count of how many times the guide was targeted to specific user/key page/day.
url	URL where the guide was triggered.
time	Timestamp when the guide execution occurred.

guide_step_executions table fields

The example below uses number_of_executionsfield event from the guide_step_executions table of the web NQL namespace.

web.guide_step_executions on 2025-02-04
| list number_of_executions
| limit 100

guide_step_executions table field	Description
execution_id	Unique identifier for the guide step execution.
status	Status of the guide step: completed: The step was completed (the user finished interacting with that step). closed: The step was closed, typically when the user closes or abandons it before completion.
url	URL where the guide step was executed.
duration	Duration the guide step was visible to the end-user.
number_of_executions	Used for calculating aggregated metrics (like count) in NQL. The value for every event is always 1.
engaged	Identifies whether the user engaged with the guide step (true/false).
browser_language	Language of the user's browser for guide step executions.
time	Timestamp when the guide step was executed.

---

RELATED TOPICS

• Understanding the Adoption tab

• Analyzing the Guide details dashboard