v1

latestOpenAPI 3.0.02026-08-064311,0881.3 MB

logSearchesManagement

Get the saved log search.

Get a saved log search from the content library by identifier.

get/v1/logSearches/{id}

Path parameters

idstring required

Identifier of the saved log search.

Response

Saved log search that was requested.

queryStringstring required

Query to perform.

runByReceiptTimeboolean

This has the value true if the search is to be run by receipt time and false if it is to be run by message time.

intervalTimeTypestring

This parameter defines whether you want to run the search by messageTime, receiptTime, or searchableTime. By default, the search will run by messageTime. If both runByReceiptTime and intervalTimeType parameters are present then the preference will be given to the intervalTimeType.

parsingModestring

Define the parsing mode to scan the JSON format log messages. Possible values are:

AutoParse
Manual In AutoParse mode, the system automatically figures out fields to parse based on the search query. While in the Manual mode, no fields are parsed out automatically. For more information see Dynamic Parsing.

namestring required

Name of the item in the content library.

descriptionstring

Item description in the content library.

propertiesstring

Aggregate Results Settings and View configurations, Legends settings, and different visualisation settings overrides. Leave this field empty to use the defaults. This property contains JSON object encoded as a string.

createdAtstring date-time required

Creation timestamp in UTC in RFC3339 format.

createdBystring required

Identifier of the user who created the resource.

modifiedAtstring date-time required

Last modification timestamp in UTC.

modifiedBystring required

Identifier of the user who last modified the resource.

idstring required

Identifier of the saved log search.

parentIdstring

Identifier of the parent element in the content library, such as folder.

Example response

{
  "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"
}