Skip to main content
POST
/
api
/
v1
/
saved_searches
CreateSavedSearch
curl --request POST \
  --url https://your-sift-api-url.com/api/v1/saved_searches \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "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
      }
    ]
  },
  "organizationId": "<string>"
}'
{
  "savedSearch": {
    "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
        }
      ]
    },
    "createdByUserId": "<string>",
    "modifiedByUserId": "<string>",
    "createdDate": "2023-11-07T05:31:56Z",
    "modifiedDate": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization
string
header
required

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

Body

application/json

The request for a call to SavedSearchService_CreateSavedSearch to create a saved search.

name
string
required
properties
object
required
organizationId
string

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

Response

A successful response.

The response for a call to SavedSearchService_CreateSavedResponse.