> For the complete documentation index, see [llms.txt](https://docs.nexthink.com/platform/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.nexthink.com/platform/user-guide/administration/content-management/nql-api-queries.md).

# NQL API queries

The NQL API allows you to extract data from the Nexthink cloud platform, giving you the flexibility to create and visualize metrics using third-party applications. Nexthink records every NQL API query execution as a platform log, so you can monitor consumption and troubleshoot failures using NQL.

Refer to the [Nexthink Developer Portal](https://developer.nexthink.com/docs/api/nql-api-overview) documentation for more information.

## Monitoring NQL API activity

The `platform.nql_api_logs` table records every NQL API query execution, across both API endpoints:

* `execute` - optimized for small queries that respond instantly, typically called by integrations that target individual employees and devices
* `export` - optimized for large queries that return bulk result sets, typically called for reporting

Query this table in the same way as any other platform log. Use the [NQL editor](/platform/user-guide/investigations/creating-investigations/nql-editor.md) of an investigation, a [live dashboard](/platform/user-guide/live-dashboards/managing-live-dashboards.md) widget or a [custom monitor](/platform/user-guide/alerts-and-diagnostics/setting-up-and-managing-monitors/creating-custom-monitors.md).

{% hint style="info" %}
Querying the `platform.nql_api_logs` table requires a role with the **Platform logs** permission enabled under **Data Model Visibility**, and full View domain access. Refer to the [Roles](/platform/user-guide/administration/account-management/roles.md) documentation for more information.
{% endhint %}

Refer to the [NQL data model](/platform/understanding-key-data-platform-concepts/nql-data-model.md#platform) documentation for the table fields and their descriptions.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.nexthink.com/platform/user-guide/administration/content-management/nql-api-queries.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.