View Search History

GET 
/search/history

Lists saved or recent search queries based on your filter.

Request

Query Parameters

filter stringrequired

Available values: recent, saved

limit int32

Maximum number of searches to be returned. A single API call retrieves a maximum of 1000 searches, which is also the default. Setting the limit to -1 will also return the default.

Responses

200

successful operation

application/json; charset=UTF-8

Schema

Schema

• Array [
createdBy string
description string
id string
lastModifiedBy string
policies object[]
query string
searchModel object

alertId string

Alert ID

async boolean

true = Is Async

asyncResultUrl string

Async Result Url

cloudType string

Possible values: [aws, azure, gcp, alibaba_cloud, oci]

Cloud Type

cursor int32

Cursor

default boolean

description string

Search Description

filters object[]

View Order

Array [

name string

Name

operator string

Possible values: [=]

Operator

value string

Value

]

groupBy string[]

Group By

id string

Search ID

name string

Search Name

query stringrequired

RQL Query

saved boolean

Search Exists

searchType string

Possible values: [network, audit_event, config, asset]

Search Type

timeGranularity string

Time Granularity

timeRange objectrequired

See the Time Range Model for details.

oneOf

RelativeTimeRangeConfigModel

relativeTimeType string

Possible values: [BACKWARD, FORWARD]

Direction in which to count time. Default = BACKWARD

type string

value objectrequired

Model for RelativeTimeDuration

amount int32

Number of time units

unit string

Possible values: [minute, hour, day, week, month, year]

Time unit

AbsoluteTimeRangeConfigModel

type string

value objectrequired

Model for Time

endTime int64

End timestamp

startTime int64

Start timestamp

ToNowTimeRangeConfigModel

value string

Possible values: [MINUTE, HOUR, DAY, WEEK, MONTH, YEAR, EPOCH, LOGIN]

Time range object

type stringrequired

Possible values: [absolute, relative, to_now]

Time type

absolute

type string

value objectrequired

Model for Time

endTime int64

End timestamp

startTime int64

Start timestamp

relative

relativeTimeType string

Possible values: [BACKWARD, FORWARD]

Direction in which to count time. Default = BACKWARD

type string

value objectrequired

Model for RelativeTimeDuration

amount int32

Number of time units

unit string

Possible values: [minute, hour, day, week, month, year]

Time unit

to_now

value string

Possible values: [MINUTE, HOUR, DAY, WEEK, MONTH, YEAR, EPOCH, LOGIN]

Time range object

searchName string
timestamp int64
• ]

Example (from schema)

[
  {
    "createdBy": "string",
    "description": "string",
    "id": "string",
    "lastModifiedBy": "string",
    "policies": [
      {}
    ],
    "query": "string",
    "searchModel": {
      "alertId": "string",
      "async": true,
      "asyncResultUrl": "/search/config/jobs/2df49d4f72e842b582b123bc2b7826b3/download",
      "cloudType": "aws",
      "cursor": 0,
      "default": true,
      "description": "string",
      "filters": [
        {
          "name": "string",
          "operator": "=",
          "value": "string"
        }
      ],
      "groupBy": [
        "string"
      ],
      "id": "string",
      "name": "string",
      "query": "string",
      "saved": true,
      "searchType": "network",
      "timeGranularity": "string",
      "timeRange": {
        "relativeTimeType": "BACKWARD",
        "type": "relative",
        "value": {
          "amount": 0,
          "unit": "minute"
        }
      }
    },
    "searchName": "string",
    "timestamp": 0
  }
]

Loading...