Skip to main content

Create a new scheduled search

POST 

/scheduled-searches

Creates a new scheduled search.

Request

Body

required

The scheduled search to persist.

    name stringnullable

    The name of the scheduled search.

    description stringnullable

    The description of the scheduled search.

    savedSearchId stringrequired

    The ID of the saved search that will be executed.

    schedule

    object

    required

    The schedule information.

    type ScheduleType (string)required

    Possible values: [DAILY, WEEKLY, MONTHLY, CALENDAR, ANNUALLY]

    Enum representing the currently supported schedule types.

    Additional values may be added in the future without notice.

    months

    object

    nullable

    The months to execute the search. This only applies to schedules with a type of ANNUALLY.

    type SelectorType (string)required

    Possible values: [LIST, RANGE]

    Enum representing the currently supported selector types.

    LIST - the values array contains one or more distinct values.

    RANGE - the values array contains two values: the start and end of the range, inclusive.

    Additional values may be added in the future without notice.

    values string[]required

    The selected values.

    interval int32nullable

    The selected interval for RANGE selectors.

    days

    object

    nullable

    The days to execute the search.

    If type is WEEKLY, the values will be MON, TUE, WED, THU, FRI, SAT, and SUN.

    If type is MONTHLY or ANNUALLY, the values will be a number in double quotes, like "1", "10", or "28". Optionally, the value "L" can be used to refer to the last day of the month.

    type SelectorType (string)required

    Possible values: [LIST, RANGE]

    Enum representing the currently supported selector types.

    LIST - the values array contains one or more distinct values.

    RANGE - the values array contains two values: the start and end of the range, inclusive.

    Additional values may be added in the future without notice.

    values string[]required

    The selected values.

    interval int32nullable

    The selected interval for RANGE selectors.

    hours

    object

    required

    The hours selected.

    type SelectorType (string)required

    Possible values: [LIST, RANGE]

    Enum representing the currently supported selector types.

    LIST - the values array contains one or more distinct values.

    RANGE - the values array contains two values: the start and end of the range, inclusive.

    Additional values may be added in the future without notice.

    values string[]required

    The selected values.

    interval int32nullable

    The selected interval for RANGE selectors.

    expiration date-timenullable

    A date-time in ISO-8601 format

    timeZoneId stringnullable

    The canonical TZ identifier the schedule will run in (ex. America/New_York). If no timezone is specified, the org's default timezone is used.

    recipients

    object[]

    required

    A list of identities that should receive the scheduled search report via email.

  • Array [

  • type stringrequired

    Possible values: [IDENTITY]

    The type of object being referenced

    id stringrequired

    The ID of the referenced object

  • ]

  • enabled boolean

    Indicates if the scheduled search is enabled.

    emailEmptyResults boolean

    Indicates if email generation should occur when search returns no results.

    displayQueryDetails boolean

    Indicates if the generated email should include the query and search results preview (which could include PII).

Responses

The persisted scheduled search.

Schema

    id string

    The scheduled search ID.

    owner

    object

    The owner of the scheduled search

    type stringrequired

    Possible values: [IDENTITY]

    The type of object being referenced

    id stringrequired

    The ID of the referenced object

    ownerId stringdeprecated

    The ID of the scheduled search owner.

    Please use the id in the owner object instead.

    name stringnullable

    The name of the scheduled search.

    description stringnullable

    The description of the scheduled search.

    savedSearchId stringrequired

    The ID of the saved search that will be executed.

    created date-timenullable

    The date the scheduled search was initially created.

    modified date-timenullable

    The last date the scheduled search was modified.

    schedule

    object

    required

    The schedule information.

    type ScheduleType (string)required

    Possible values: [DAILY, WEEKLY, MONTHLY, CALENDAR, ANNUALLY]

    Enum representing the currently supported schedule types.

    Additional values may be added in the future without notice.

    months

    object

    nullable

    The months to execute the search. This only applies to schedules with a type of ANNUALLY.

    type SelectorType (string)required

    Possible values: [LIST, RANGE]

    Enum representing the currently supported selector types.

    LIST - the values array contains one or more distinct values.

    RANGE - the values array contains two values: the start and end of the range, inclusive.

    Additional values may be added in the future without notice.

    values string[]required

    The selected values.

    interval int32nullable

    The selected interval for RANGE selectors.

    days

    object

    nullable

    The days to execute the search.

    If type is WEEKLY, the values will be MON, TUE, WED, THU, FRI, SAT, and SUN.

    If type is MONTHLY or ANNUALLY, the values will be a number in double quotes, like "1", "10", or "28". Optionally, the value "L" can be used to refer to the last day of the month.

    type SelectorType (string)required

    Possible values: [LIST, RANGE]

    Enum representing the currently supported selector types.

    LIST - the values array contains one or more distinct values.

    RANGE - the values array contains two values: the start and end of the range, inclusive.

    Additional values may be added in the future without notice.

    values string[]required

    The selected values.

    interval int32nullable

    The selected interval for RANGE selectors.

    hours

    object

    required

    The hours selected.

    type SelectorType (string)required

    Possible values: [LIST, RANGE]

    Enum representing the currently supported selector types.

    LIST - the values array contains one or more distinct values.

    RANGE - the values array contains two values: the start and end of the range, inclusive.

    Additional values may be added in the future without notice.

    values string[]required

    The selected values.

    interval int32nullable

    The selected interval for RANGE selectors.

    expiration date-timenullable

    A date-time in ISO-8601 format

    timeZoneId stringnullable

    The canonical TZ identifier the schedule will run in (ex. America/New_York). If no timezone is specified, the org's default timezone is used.

    recipients

    object[]

    required

    A list of identities that should receive the scheduled search report via email.

  • Array [

  • type stringrequired

    Possible values: [IDENTITY]

    The type of object being referenced

    id stringrequired

    The ID of the referenced object

  • ]

  • enabled boolean

    Indicates if the scheduled search is enabled.

    emailEmptyResults boolean

    Indicates if email generation should occur when search returns no results.

    displayQueryDetails boolean

    Indicates if the generated email should include the query and search results preview (which could include PII).

Loading...