id, title, pagination_label, sidebar_label, sidebar_class_name, keywords, slug, tags
| id |
title |
pagination_label |
sidebar_label |
sidebar_class_name |
keywords |
slug |
tags |
| v2025-scheduled-search |
ScheduledSearch |
ScheduledSearch |
ScheduledSearch |
pythonsdk |
| python |
| Python |
| sdk |
| ScheduledSearch |
| V2025ScheduledSearch |
|
/tools/sdk/python/v2025/models/scheduled-search |
| SDK |
| Software Development Kit |
| ScheduledSearch |
| V2025ScheduledSearch |
|
ScheduledSearch
Properties
| Name |
Type |
Description |
Notes |
| name |
str |
The name of the scheduled search. |
[optional] |
| description |
str |
The description of the scheduled search. |
[optional] |
| saved_search_id |
str |
The ID of the saved search that will be executed. |
[required] |
| created |
datetime |
The date the scheduled search was initially created. |
[optional] [readonly] |
| modified |
datetime |
The last date the scheduled search was modified. |
[optional] [readonly] |
| schedule |
Schedule2 |
|
[required] |
| recipients |
[]SearchScheduleRecipientsInner |
A list of identities that should receive the scheduled search report via email. |
[required] |
| enabled |
bool |
Indicates if the scheduled search is enabled. |
[optional] [default to False] |
| email_empty_results |
bool |
Indicates if email generation should occur when search returns no results. |
[optional] [default to False] |
| display_query_details |
bool |
Indicates if the generated email should include the query and search results preview (which could include PII). |
[optional] [default to False] |
| id |
str |
The scheduled search ID. |
[required][readonly] |
| owner |
ScheduledSearchAllOfOwner |
|
[required] |
| owner_id |
str |
The ID of the scheduled search owner. Please use the id in the owner object instead. |
[required][readonly] |
| } |
|
|
|
Example
[Back to top]