Skip to main content

CreateScheduledSearchV1Request

Properties

NameTypeDescriptionNotes
name(optional) stringThe name of the scheduled search.[default to undefined]
description(optional) stringThe description of the scheduled search.[default to undefined]
savedSearchIdstringThe ID of the saved search that will be executed.[default to undefined]
created(optional) stringThe date the scheduled search was initially created.[readonly] [default to undefined]
modified(optional) stringThe last date the scheduled search was modified.[readonly] [default to undefined]
scheduleSchedule[default to undefined]
recipientsArray<SearchscheduleRecipientsInner>A list of identities that should receive the scheduled search report via email.[default to undefined]
enabled(optional) booleanIndicates if the scheduled search is enabled.[default to false]
emailEmptyResults(optional) booleanIndicates if email generation should occur when search returns no results.[default to false]
displayQueryDetails(optional) booleanIndicates if the generated email should include the query and search results preview (which could include PII).[default to false]