Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 

GET /ariel/saved_searches

 

Retrieves a list of Ariel saved searches.

Retrieves a list of Ariel saved searches.

Table 1: GET /ariel/saved_searches Resource Details

MIME Type

application/json

Table 2: GET /ariel/saved_searches Request Parameter Details

Parameter

Type

Optionality

Data Type

MIME Type

Description

Range

header

Optional

String

text/plain

Optional - Use this parameter to restrict the number of elements that are returned in the list to a specified range. The list is indexed starting at zero.

fields

query

Optional

String

text/plain

Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas.

filter

query

Optional

String

text/plain

Optional - This parameter is used to restrict the elements in a list base on the contents of various fields.

Table 3: GET /ariel/saved_searches Response Codes

HTTP Response Code

Unique Code

Description

200

 

The Ariel saved searches were retrieved.

422

1010

A request parameter is not valid.

500

1020

An error occurred during the attempt to retrieve the Ariel Saved Searches.

Response Description

An array of Ariel Saved Search objects. An Ariel Saved Search object contains the following fields:

  • id - Long - The ID of the Ariel saved search.

  • uid - String - The uuid of the Ariel saved search.

  • name - String - The name of the Ariel saved search.

  • database - String - The database of the Ariel saved search, events or flows.

  • isShared - Boolean - True if the Ariel saved search is shared with other users.

  • owner - String - The owner of the Ariel saved search.

  • aql - String - The AQL query.

  • description - String - The description of the Ariel saved search.

  • is_aggregate - Boolean - True if the Ariel saved search is an aggregate search.

  • is_dashboard - Boolean - True if the Ariel saved search is in the dashboard.

  • is_default - Boolean - True if the Ariel saved search is default search.

  • creation_date - Long - The time that this saved search was created, in milliseconds since the epoch.

  • modification_date - Long - The time that this saved search was most recently modified, in milliseconds since the epoch.

Response Sample