Search Saved Searches

Search_Saved_Searches returns saved search records that teams use to persist search criteria and monitor result changes over time.

When To Use

Typical questions this tool answers well:

  • Which saved searches already exist for this workspace or user?

  • What criteria, filters, and cadence are configured for a specific saved search?

  • Which saved searches belong to one owner or were created by a specific user?

  • Which saved searches match a topic or phrase in their saved query content?

  • What is the search_persistence_id or result URL I need for related saved-search workflows?

Required Reading

  1. Search_Query_Guide: Required before setting free-text query strings when search_mode is used.

  2. Search_Mode_Guide: Required before choosing keyword vs semantic retrieval.

Input Contract

  • query: Free-text query string. See Required Reading: Search_Query_Guide.

    • type: string

    • required: no

    • default: n/a

  • page: 1-based page index.

    • type: null|number

    • required: no

    • default: 1

  • per_page: Rows per page.

    • type: null|number

    • required: no

    • default: 10

  • search_mode: Query interpretation mode. See Required Reading: Search_Mode_Guide.

    • type: string

    • required: no

    • default: keyword

    • options: keyword, semantic

  • owner_ids: Filter by owners. Use GovTribe IDs.

    • type: array<string>

    • required: no

    • default: n/a

  • owner_ids_operator: Choose whether to include or exclude values for Owner GovTribe IDs.

    • type: null|string

    • required: no

    • default: in

    • options: in, not_in

  • creator_ids: Filter by creators. Use GovTribe IDs.

    • type: array<string>

    • required: no

    • default: n/a

  • creator_ids_operator: Choose whether to include or exclude values for Creator GovTribe IDs.

    • type: null|string

    • required: no

    • default: in

    • options: in, not_in

  • saved_search_ids: Include or exclude results by GovTribe IDs.

    • type: array<string>

    • required: no

    • default: n/a

  • saved_search_ids_operator: Choose whether to include or exclude values for GovTribe IDs.

    • type: null|string

    • required: no

    • default: in

    • options: in, not_in

  • sort: Sort configuration.

    • type: object

    • required: no

    • default: n/a

    • shape: { key?: null|string, direction?: null|string }

    • options: key: lastSent, created_at, _score; direction: asc, desc

  • fields_to_return: Optional field list for row payloads. If omitted and per_page > 0, rows default to govtribe_id. For per_page: 0 aggregation/meta calls, this field may be omitted. Specify fields_to_return whenever the user asks for fields beyond govtribe_id, and prefer omitting it in pure aggregation workflows.

    • type: array<string>

    • required: no

    • default: n/a

    • options: govtribe_id, govtribe_type, govtribe_url, name, frequency, q, filters, sorts, view_results_url, searches_govtribe_type, search_persistence_id, last_sent, created_at, updated_at, owner, creator

Output Contract

  • Top-level keys:

    • current_page: Current page number when per_page > 0.

    • data: Array of result rows when per_page > 0.

    • from: First row position in the current page.

    • last_page: Last page number for current filters.

    • path: GovTribe search URL for this result set.

    • per_page: Applied page size.

    • to: Last row position in the current page.

    • total: Total matched row count for current query filters.

    • contains: Dataset label for the returned result set.

    • search_results_id_can_generate_saved_search: Saved-search eligibility flag.

    • search_results_id: Server-side search result identifier.

    • view_search_results_url: URL to open this exact result set.

    • per_page: 0 behavior: returns only path, total, contains, search_results_id_can_generate_saved_search, search_results_id, and view_search_results_url.

  • Row keys:

    • govtribe_id

    • govtribe_type

    • govtribe_url

    • name

    • frequency

    • q

    • filters

    • sorts

    • view_results_url

    • searches_govtribe_type

    • search_persistence_id

    • last_sent

    • created_at

    • updated_at

    • owner

    • creator

  • Relationship retrieval map:

    • creator

      • resource_type: user

      • tool: Search_Users

      • filter: user_ids

      • nested_keys: govtribe_id, govtribe_type, name, email

    • owner

      • resource_type: user

      • tool: Search_Users

      • filter: user_ids

      • nested_keys: govtribe_id, govtribe_type, name, email

Usage Patterns

Pattern A: List saved searches with default keyword behavior. Tool: Search_Saved_Searches

Pattern B: Exact lookup by saved-search name. Tool: Search_Saved_Searches

Pattern C: Fetch only saved searches owned by specific users. Tool: Search_Saved_Searches

Pattern D: Exclude saved searches created by a service account. Tool: Search_Saved_Searches

Pattern E: Metadata-only response to get count and reusable result identifier. Tool: Search_Saved_Searches

Then rerun with the same filters and per_page > 0 to fetch row payloads.

Last updated

Was this helpful?