Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
ON THIS PAGE
 

GET /dynamic_search/searches/{handle}

SUMMARY Gets the specific search performed by this user.

Gets the specific search performed by this user.

Table 1: GET /dynamic_search/searches/{handle} resource details:

GET /dynamic_search/searches/{handle} resource details

MIME Type

application/json

Table 2: GET /dynamic_search/searches/{handle} request parameter details:

GET /dynamic_search/searches/{handle} request parameter details

Parameter Type Optionality Data Type MIME Type Description

handle

path

Required

String

text/plain

The handle which uniquely identifies this search.

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 /dynamic_search/searches/{handle} response codes:

GET /dynamic_search/searches/{handle} response codes

HTTP Response Code Unique Code Description

200

A list of searches that the user has made.

404

1024

No search was found with the provided handle

422

1015

Please provide correct field constraints

Response Description

The specific search performed by this user.
  • handle - String - The unique, server-generated UUID that represents this search.
  • status - String - The current status of this search, one of (POSTED, QUEUED, RUNNING, DONE, or ERROR)
  • search_type - String - The type of this search, one of (SYNCH or ASYNCH). Defaults to ASYNCH.
  • storage_type - String - The storage type of this search, one of (NONE, COLD, or HOT). Legal combos with search_type are SYNCH/NONE, ASYNCH/COLD, or ASYNCH/HOT. Defaults to COLD.
  • retention - The date/time info related to this search.
    • creation_date - Long - The date and time that this search was posted, in milliseconds since the epoch.
    • last_accessed_date - Long - The date and time that the results for this search were last accessed, in milliseconds since the epoch.
    • expires_at - Long - The date and time until which that this search will be kept, in milliseconds since the epoch.
    • retain_duration - Long - The number of milliseconds (counting from creation_date) to keep this search and the associated results.
  • description - String - A user-supplied freeform string used to store identifying or descriptive information. It has no effect on search execution.
  • header - An explanation of the structure of the results below. Can not filter on this.
    • columns - A description of the returned columns
      • field - One of the fields requested in this search.
      • column_name - String - The name of the column variable that contains that field. Always of the form "columnN".
  • query - The query that created this search. Can not filter on this.
    • fields - A list of the fields which specifies the columns returned by this search.
    • filters - A list of the conditions that will filter the row returned by this search
      • argument - The argument field for this filter.
      • parameters - A list of string parameters for this filter.
      • operator - The operator for this filter. Must be a value returned from the Operators endpoint or a valid logical operator (AND, OR, NOT).
      • left_filter - The left child of the complex filter case. Must be not-null if operator is (AND or OR) and null otherwise.
      • right_filter - The right child of the complex filter case. Must be not-null if operator is (AND, OR or NOT) and null otherwise.
    • sorts - An ordered list of the Sorts (each a Field plus a direction (ASC/DESC)) that should be applied to the results of this search
      • field - The field on which to apply sorting.
      • direction - String - The direction of the sort (must be one of ASC/DESC).
    • range - A specification of the limit and offset that should be applied to the results returned by this search. If a range is specified, at least one sort must also be specified.
      • limit - Integer - The non-negative number of results to return.
      • offset - Integer - The non-negative position at which to begin returning results.
  • results - The list of results returned by this search.
    • columns -Contains a map of columns and their values, both as strings.

Response Sample