ListSavedSearches

List saved searches.

GET /api/v1/saved_searches

ListSavedSearches

cURL

curl --request GET \
  --url https://api.siftstack.com/api/v1/saved_searches \
  --header 'Authorization: Bearer <token>'

200

{
  "savedSearches": [
    {
      "savedSearchId": "<string>",
      "organizationId": "<string>",
      "name": "<string>",
      "properties": {
        "overviewMode": "<string>",
        "searchTerm": "<string>",
        "fromDateTime": "2023-11-07T05:31:56Z",
        "toDateTime": "2023-11-07T05:31:56Z",
        "assetItems": [
          {
            "id": "<string>",
            "name": "<string>"
          }
        ],
        "userItems": [
          {
            "id": "<string>",
            "name": "<string>"
          }
        ],
        "tagItems": [
          {
            "id": "<string>",
            "name": "<string>"
          }
        ],
        "annotationItems": [
          {
            "id": "<string>",
            "name": "<string>"
          }
        ],
        "runItems": [
          {
            "id": "<string>",
            "name": "<string>"
          }
        ],
        "reportTemplateItems": [
          {
            "id": "<string>",
            "name": "<string>"
          }
        ],
        "showAdvancedFilters": true,
        "includeArchived": true,
        "orderBy": "<string>",
        "metadataItems": [
          {
            "key": "<string>",
            "stringValue": "<string>",
            "numberValue": 123,
            "booleanValue": true
          }
        ],
        "duration": "<string>"
      },
      "createdByUserId": "<string>",
      "modifiedByUserId": "<string>",
      "createdDate": "2023-11-07T05:31:56Z",
      "modifiedDate": "2023-11-07T05:31:56Z"
    }
  ],
  "nextPageToken": "<string>"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

pageSize · integer<int64>

The maximum number of saved searches to return. The service may return fewer than this value. If unspecified, at most 50 saved searches will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. Optional.

pageToken · string

A page token, received from a previous ListSavedSearches call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListSavedSearches must match the call that provided the page token. Optional.

filter · string

A Common Expression Language (CEL) filter string. Available fields to filter by are 'name', 'saved_search_id', and 'overview_mode'. For further information about how to use CELs, please refer to this guide.

organizationId · string

This field is only required if your user belongs to multiple organizations.

orderBy · string

How to order the retrieved saved searches. Formatted as a comma-separated string i.e. "FIELD_NAME[ desc],...". Available fields to order_by are name, created_date, and modified_date. If left empty, items are ordered by created_date in ascending order (oldest-first). For more information about the format of this field, read this Example: "created_date desc,modified_date"

Response

200

application/json

A successful response.

The response of a call to SavedSearchService_ListSavedSearchesResponse.

savedSearches · object[]

Show child attributes

nextPageToken · string