Save

Users can save search criteria and manage custom integrations for real-time alerting and modeling. Searches can be saved and managed using the Platform and API.

Note: Saved searches are essential when using Integrations to automatically deliver matching content to external systems.

Core Operations

Operation

Description

Platform

API

Create

Save current search criteria with a name

“Save & Search” button after entering search name

POST to /v1/user/search

List All

View all saved searches

Click “Manage Searches” button on Platform tab

GET to /v1/user/search

Execute

Run a saved search

Click on a saved search row in the list

Extract payload from GET search response and POST to /athena/v1/query-snippet

Edit

Modify an existing saved search

Click triple-dot icon in Actions column, then select pencil icon

PUT to /v1/user/search/{search_id}

Delete

Remove a saved search

Click triple-dot icon in Actions column, then select trash icon

DELETE to /v1/user/search/{search_id}

Link to Integration

Enable automatic delivery of matching content

Toggle the “Enable Integration” switch in the saved search row

PUT to /v1/user/search/{search_id} with active: true

Activate Integration

The automated content delivery system requires two active components:

  1. Turn on Saved Search:

    • In Platform: Toggle ‘Enable Integration’ switch to ON

    • In API: Set active: true when creating or updating a saved search

  2. Turn on Integration:

    • Integrations set up with the same league must be activated (see Integrations)

    • Search results will ONLY be delivered to integrations if the integration is set up with the same league as the criteria

Once completed, our systems will continuously monitor for new reports matching your saved criteria and automatically deliver data to all your active integrations.

Note: Multiple saved searches can deliver to the same integration, and a single saved search can deliver to multiple integrations, as long as they share the same league.

For complete API documentation, see the API Reference.