Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 

POST /ariel/searches

 

Create a new asynchronous Ariel search.

Creates a new Ariel search as specified by the Ariel Query Language (AQL) query expression. Searches are executed asynchronously. A reference to the search ID is returned and should be used in subsequent API calls to determine the status of the search and retrieve the results once it is complete.

This endpoint only accepts SELECT query expressions.

Queries are applied to the range of data in a certain time interval. By default this time interval is the last 60 seconds. An alternative time interval can be specified by specifying them as part of the query expression. For further information, see the AQL reference guide.

Table 1: POST /ariel/searches Resource Details

MIME Type

application/json

Table 2: POST /ariel/searches Request Parameter Details

Parameter

Type

Optionality

Data Type

MIME Type

Description

query_expression

query

Optional

String

text/plain

Optional - The AQL query to execute. Mutually exclusive with saved_search_id

saved_search_id

query

Optional

Number (Integer)

text/plain

Optional - Saved search ID to execute. Mutually exclusive with queryExpression

data_lake

query

Optional

String

text/plain

Optional - If the search should be executed for QCDL then "qcdl" should be entered in this field. Only "qcdl" can be entered in this field

Table 3: POST /ariel/searches Response Codes

HTTP Response Code

Unique Code

Description

201

 

A new Ariel search was successfully created.

404

1002

The Ariel saved search does not exist.

409

1004

The search cannot be created. The requested search ID that was provided in the query expression is already in use. Please use a unique search ID (or allow one to be generated).

422

2000

The query_expression contains invalid AQL syntax.

422

1005

A request parameter is not valid.

500

1020

An error occurred during the attempt to create a new search.

503

1010

The Ariel server might be temporarily unavailable or offline. Please try again later.

Response Description

Information about the specified search, including the search ID. Use the search ID to access or manipulate the search with the other API endpoints.

If the exact search being created was already recently created, the response message will return a reference to the original search ID rather than creating a new search.

Response Sample