GET /ariel/saved_searches/{id}

Retrieves an Ariel saved search.

Table 1. GET /ariel/saved_searches/{id} resource details
MIME Type
application/json

Table 2. GET /ariel/saved_searches/{id} request parameter details
Parameter	Type	Optionality	Data Type	MIME Type	Description
id	path	Required	Number (Integer)	text/plain	Required - The ID of the Ariel Saved Search to retrieve.
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.

Table 3. GET /ariel/saved_searches/{id} response codes
HTTP Response Code	Unique Code	Description
200		The Ariel saved search was retrieved.
404	1002	The Ariel saved search does not exist.
500	1020	An error occurred during the attempt to retrieve the Ariel Saved Search.

Response Description

The Ariel saved search after it is retrieved. An Ariel Saved Search object contains the following fields:

id - Long - The ID of the Ariel saved search.
uuid - 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.
isAggregate - Boolean - True if the Ariel saved search is an aggregate search.
isDashboard - Boolean - True if the Ariel saved search is in the dashboard.
isDefault - Boolean - True if the Ariel saved search is default search.
isQuickSearch - Boolean - True if the Ariel saved search is default search.

Response Sample


{
    "aql": "String",
    "creation_date": 42,
    "database": "String <one of: EVENTS, FLOWS, ASSETS>",
    "description": "String",
    "id": 42,
    "is_aggregate": true,
    "is_dashboard": true,
    "is_default": true,
    "is_quick_search": true,
    "is_shared": true,
    "modified_date": 42,
    "name": "String",
    "owner": "String",
    "uid": "String"
}