Document toolboxDocument toolbox

Running queries with the Query API

Overview

Check the list of available endpoints and methods to work with the Query API:

Endpoints and methods

Description

Endpoints and methods

Description

POST /query see below

Run a query.

Endpoints and methods

POST /query

Use this endpoint tu run a query through the API.

Relative dates

A relative date range is a period of time that is relative to the current date (last week, last month, etc). You can add different operators to the from and to parameters of your query request to indicate specific time ranges. Note that the date you enter in the to parameter must always be greater than or equal to the from date.

For all the examples that don't use a timestamp to specify a date, we assume that the moment of execution is 08-10-2018, 14:33:12 UTC.

Query response formats

Responses to your queries can be either returned to the source of the request, forwarded to an HDFSS3, SNMP, or Kafka type system, or sent via email.

Given the different possible destinations for query responses, you can also specify the format in which you want the response to be sent. This is specified in the mode.type parameter of the request body. The available response formats are: