Execute an NQL

Execute NQL queries and retrieve data in JSON or CSV format

Execute an NQL V1

post

Executes an NQL query and returns the results.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

AuthorizationstringOptional

Acceptstring · nullableOptional

Set the header to application/json for a JSON response or text/csv for a CSV response. If no value is set, application/json applied by default. Otherwise, 406 error (not acceptable) is returned.

Example: application/json

x-utc-timesstring · nullableOptional

Set the header to true for UTC timezone. With any other value, regional timezone is applied by default.

Example: true

Body

application/json

queryIdstring · min: 1 · max: 255Required

Identifier of the query which is going to be executed.

Example: #my_query_idPattern: ^#[a-z0-9_]{2,255}$

Responses

200

OK - Successful execution.

application/jsontext/csv

queryIdstringOptional

Identifier of the executed query

executedQuerystringOptional

Final query executed with the replaced parameters.

rowsinteger · int64Optional

Number of rows returned

headersstring[]Optional

Ordered list with the headers of the returned fields.

dataobject[][]Optional

List of rows with the data returned by the query execution.

401

Unauthorized - No valid authentication credentials.

403

No permission - Not authorized to execute queries.

application/json

404

Not found - No query associated with that ID.

406

Not Acceptable. The Accept header should be "application/json", "text/csv" or empty.

500

Internal server error.

application/json

503

Service unavailable.

post/api/v1/nql/execute

HTTPcURLJavaScriptPython

POST /api/v1/nql/execute HTTP/1.1
Host: instance.api.region.nexthink.cloud
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 111

{
  "queryId": "#my_query_id",
  "parameters": {
    "parameterName1": "parameterValue1",
    "parameterName2": "parameterValue2"
  }
}

{
  "queryId": "text",
  "executedQuery": "text",
  "rows": 1,
  "executionDateTime": {
    "year": 1,
    "month": 1,
    "day": 1,
    "hour": 1,
    "minute": 1,
    "second": 1
  },
  "headers": [
    "text"
  ],
  "data": [
    [
      {}
    ]
  ]
}

Execute an NQL V2

post

Executes an NQL query and returns the results.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

AuthorizationstringOptional

Acceptstring · nullableOptional

Set the header to application/json for a response or text/csv for a CSV response. If no value is set, application/json is applied by default. Otherwise, 406 error (not acceptable) is returned.

Example: application/json

x-utc-timesstring · nullableOptional

Set the header to true for UTC timezone. With any other value, regional timezone is applied by default.

Example: true

Body

application/json

queryIdstring · min: 1 · max: 255Required

Identifier of the query which is going to be executed.

Example: #my_query_idPattern: ^#[a-z0-9_]{2,255}$

Responses

200

OK - Successful execution.

application/jsontext/csv

queryIdstringOptional

Identifier of the executed query

executedQuerystringOptional

Final query executed with the parameters replaced

rowsinteger · int64Optional

Number of rows returned

executionDateTimestringOptional

Date and time of the execution in ISO format

Example: 2023-03-07T15:56:02

401

Unauthorized - No valid authentication credentials.

403

No permission - Not authorized to execute queries

application/json

404

Not found - No query associated with that ID

406

Not Acceptable - The accept header should be "application/json", "text/csv" or empty

500

Internal server error

application/json

503

Service unavailable

post/api/v2/nql/execute

HTTPcURLJavaScriptPython

POST /api/v2/nql/execute HTTP/1.1
Host: instance.api.region.nexthink.cloud
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 111

{
  "queryId": "#my_query_id",
  "parameters": {
    "parameterName1": "parameterValue1",
    "parameterName2": "parameterValue2"
  }
}

{
  "queryId": "text",
  "executedQuery": "text",
  "rows": 1,
  "executionDateTime": "2023-03-07T15:56:02",
  "data": [
    {
      "key1": "my-device",
      "key2": "device-info"
    }
  ]
}