v1

latestOpenAPI 3.0.02026-08-064311,0881.3 MB

logSearchesManagement

List all saved log searches.

List all saved log searches viewable by the user.

get/v1/logSearches

Query parameters

limitinteger

Limit the number of log searches returned in the response. The number of log searches returned may be less than the limit.

tokenstring

Continuation token to get the next page of results. A page object with the next continuation token is returned in the response body. Subsequent GET requests should specify the continuation token to get the next page of results. token is set to null when no more pages are left.

Response

Paginated list of log searches under the Personal folder created by the user.

warningsstring[]

List of warning messages for invalid log search definitions.

tokenstring

Next continuation token. token is set to null when no more pages are left.

Example response

{
  "logSearches": [
    {
      "queryString": "error {{sourceCategory}}| count by _sourceCategory",
      "timeRange": {
        "type": "BeginBoundedTimeRange",
        "from": {
          "type": "RelativeTimeRangeBoundary",
          "relativeTime": "-15m"
        }
      },
      "queryParameters": [
        {
          "autoComplete": {
            "type": "SKIP_AUTOCOMPLETE",
            "autoCompleteKey": "Ephemeral-3644138589235809747-1583470806220-parameter",
            "lookupMetaData": {
              "fileName": "users.csv",
              "valueColumn": "user_id",
              "labelColumn": "user_name"
            }
          },
          "name": "sourceCategory",
          "description": "source category for the string",
          "dataType": "STRING",
          "value": "apache"
        }
      ],
      "intervalTimeType": "messageTime",
      "parsingMode": "AutoParse",
      "name": "Short title",
      "description": "Long and detailed description",
      "schedule": {
        "cronExpression": "0 0/15 * * * ? *",
        "displayableTimeRange": "-2h",
        "parseableTimeRange": {
          "type": "BeginBoundedTimeRange",
          "from": {
            "type": "RelativeTimeRangeBoundary",
            "relativeTime": "-15m"
          }
        }
      },
      "properties": "{ \"key\": \"value\" }",
      "createdAt": "2018-10-16T09:10:00Z",
      "createdBy": "0000000006743FDD",
      "modifiedAt": "2018-10-16T09:10:00Z",
      "modifiedBy": "0000000006743FE8",
      "id": "000000000000001A",
      "parentId": "0000000000007D2B"
    }
  ],
  "warnings": [
    "Invalid saved search: <saved_search_name>. Please validate your saved search."
  ],
  "token": "GDCiRv4vebF3UWFJQ1kySXBOR3Bzh69GR0RyWm9vCtc"
}