CreateSavedSearch
curl --request POST \
--url https://api.siftstack.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>"
}
'import requests
url = "https://api.siftstack.com/api/v1/saved_searches"
payload = {
"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>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.siftstack.com/api/v1/saved_searches"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"properties\": {\n \"overviewMode\": \"<string>\",\n \"searchTerm\": \"<string>\",\n \"fromDateTime\": \"2023-11-07T05:31:56Z\",\n \"toDateTime\": \"2023-11-07T05:31:56Z\",\n \"assetItems\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"userItems\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"tagItems\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"annotationItems\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"runItems\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"reportTemplateItems\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"showAdvancedFilters\": true,\n \"includeArchived\": true,\n \"orderBy\": \"<string>\",\n \"metadataItems\": [\n {\n \"key\": \"<string>\",\n \"stringValue\": \"<string>\",\n \"numberValue\": 123,\n \"booleanValue\": true\n }\n ]\n },\n \"organizationId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"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"
}
}{
"code": 123,
"message": "<string>",
"details": [
{
"@type": "<string>"
}
]
}SavedSearchService
CreateSavedSearch
Create a saved search.
POST
/
api
/
v1
/
saved_searches
CreateSavedSearch
curl --request POST \
--url https://api.siftstack.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>"
}
'import requests
url = "https://api.siftstack.com/api/v1/saved_searches"
payload = {
"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>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.siftstack.com/api/v1/saved_searches"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"properties\": {\n \"overviewMode\": \"<string>\",\n \"searchTerm\": \"<string>\",\n \"fromDateTime\": \"2023-11-07T05:31:56Z\",\n \"toDateTime\": \"2023-11-07T05:31:56Z\",\n \"assetItems\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"userItems\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"tagItems\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"annotationItems\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"runItems\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"reportTemplateItems\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"showAdvancedFilters\": true,\n \"includeArchived\": true,\n \"orderBy\": \"<string>\",\n \"metadataItems\": [\n {\n \"key\": \"<string>\",\n \"stringValue\": \"<string>\",\n \"numberValue\": 123,\n \"booleanValue\": true\n }\n ]\n },\n \"organizationId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"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"
}
}{
"code": 123,
"message": "<string>",
"details": [
{
"@type": "<string>"
}
]
}Authorizations
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.
Response
A successful response.
The response for a call to SavedSearchService_CreateSavedResponse.
Show child attributes
Show child attributes
Was this page helpful?
⌘I